home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 2 / Gold Medal Software Volume 2 (Gold Medal) (1994).iso / database / tldr22.arj / TOOLDRIV.DOC < prev    next >
Text File  |  1993-06-15  |  98KB  |  2,749 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8. T o o l D r i v e r
  9. Version 2.02
  10. ────────────────────
  11. User's Guide
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18. Organizing files and naming conventions /
  19.   Professional Tools /
  20.      for Software Developers and Consultants
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.                                  ┌───────┐
  30.                             ┌───────┐    │                (R)
  31.                           ──│       │    │───────────────────
  32.                             │  ┌───────┐ │  Association of
  33. ConVal Software, Inc.       │  │       │─┘  Shareware
  34.                             └──│   o   │    Professionals
  35.                           ─────│   |   │─────────────────────
  36.                                └───┴───┘    MEMBER
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56. T o o l D r i v e r
  57. Version 2.02
  58. ────────────────────
  59. User's Guide
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66. Organizing files and naming conventions /
  67.   Professional Tools /
  68.      for Software Developers and Consultants
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.                                  ┌───────┐
  78.                             ┌───────┐    │                (R)
  79.                           ──│       │    │───────────────────
  80.                             │  ┌───────┐ │  Association of
  81. ConVal Software, Inc.       │  │       │─┘  Shareware
  82.                             └──│   o   │    Professionals
  83.                           ─────│   |   │─────────────────────
  84.                                └───┴───┘    MEMBER
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104. Copyright 1990-1993 ConVal Software, Inc.
  105. All rights reserved.
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114. This program is produced by a member of the Association of Shareware
  115. Professionals (ASP). ASP wants to make sure that the shareware principle
  116. works for you. If you are unable to resolve a shareware-related problem
  117. with an ASP member by contacting the member directly, ASP may be able to
  118. help. The ASP Ombudsman can help you resolve a dispute or problem with an
  119. ASP member, but does not provide technical support for members' products.
  120.  
  121. Please write to the ASP Ombudsman at:
  122.  
  123. ASP Ombudsman
  124. 545 Grover Road
  125. Muskegon, MI  49442-9427
  126. U.S.A.
  127.  
  128. or send a CompuServe message via CompuServe MAIL to ASP Ombudsman
  129. 70007,3536.
  130.  
  131. The ombudsman may be contacted by FAX by sending to the ASP FAX number:
  132. (616) 788-2765. In communication with the ombudsman please include a
  133. telephone number and/or FAX if available.
  134.  
  135. Turbo Vision (c) is a registered trademark of Borland International, Inc.
  136. Portions Copyright Borland International, Inc. Used by permission.
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.                                        iv
  153.  
  154.                                  TABLE OF CONTENTS
  155.  
  156. Preface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   8
  157.  
  158. SECTION 1: Introduction. . . . . . . . . . . . . . . . . . . . . . . . .   9
  159. What's in ToolDriver?. . . . . . . . . . . . . . . . . . . . . . . . . .   9
  160. Hardware and software requirements . . . . . . . . . . . . . . . . . . .   9
  161. How to contact ConVal Software . . . . . . . . . . . . . . . . . . . . .   9
  162. The ToolDriver package . . . . . . . . . . . . . . . . . . . . . . . . .  10
  163.  
  164. SECTION 2: Installing ToolDriver . . . . . . . . . . . . . . . . . . . .  10
  165. To install ToolDriver. . . . . . . . . . . . . . . . . . . . . . . . . .  10
  166. Running ToolDriver . . . . . . . . . . . . . . . . . . . . . . . . . . .  10
  167.  
  168. SECTION 3: ToolDriver Basics . . . . . . . . . . . . . . . . . . . . . .  11
  169. Starting ToolDriver. . . . . . . . . . . . . . . . . . . . . . . . . . .  11
  170. Exiting ToolDriver . . . . . . . . . . . . . . . . . . . . . . . . . . .  11
  171. The User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . .  11
  172.    The menu bar and menus. . . . . . . . . . . . . . . . . . . . . . . .  11
  173.    Working with windows. . . . . . . . . . . . . . . . . . . . . . . . .  15
  174.    The status line . . . . . . . . . . . . . . . . . . . . . . . . . . .  18
  175.    Dialog boxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . .  19
  176.    Action buttons. . . . . . . . . . . . . . . . . . . . . . . . . . . .  19
  177.    Radio Buttons and check boxes . . . . . . . . . . . . . . . . . . . .  19
  178.    Input boxes and list boxes. . . . . . . . . . . . . . . . . . . . . .  20
  179.  
  180. SECTION 4: Menus and options reference . . . . . . . . . . . . . . . . .  20
  181. ≡ (System) menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . .  20
  182.    Register. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  21
  183.    Product Information . . . . . . . . . . . . . . . . . . . . . . . . .  21
  184. File menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  21
  185.    View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  21
  186.    Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  22
  187.    Change Dir. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  22
  188.    DOS Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  23
  189.    Quit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  24
  190. Edit menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  24
  191.    File Extension. . . . . . . . . . . . . . . . . . . . . . . . . . . .  25
  192.    Cut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  26
  193.    Copy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  26
  194.    Paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  26
  195.    Show Clipboard. . . . . . . . . . . . . . . . . . . . . . . . . . . .  27
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.                                        v
  212. Search menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  27
  213.    Find. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  27
  214.    Replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  28
  215.    Search Again. . . . . . . . . . . . . . . . . . . . . . . . . . . . .  28
  216. FileXref Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  29
  217.    Files to cross reference. . . . . . . . . . . . . . . . . . . . . . .  29
  218.    Words to cross reference. . . . . . . . . . . . . . . . . . . . . . .  30
  219.    Start cross referencing . . . . . . . . . . . . . . . . . . . . . . .  32
  220.       Extended Reports . . . . . . . . . . . . . . . . . . . . . . . . .  33
  221.       Condensed Reports. . . . . . . . . . . . . . . . . . . . . . . . .  36
  222.       File Parts List Report . . . . . . . . . . . . . . . . . . . . . .  37
  223.       Export files . . . . . . . . . . . . . . . . . . . . . . . . . . .  37A
  224.    View the output log . . . . . . . . . . . . . . . . . . . . . . . . .  39
  225. NameChanger menu . . . . . . . . . . . . . . . . . . . . . . . . . . . .  40
  226.    Files to process. . . . . . . . . . . . . . . . . . . . . . . . . . .  41
  227.    Names to be changed . . . . . . . . . . . . . . . . . . . . . . . . .  42
  228.    Start name changing . . . . . . . . . . . . . . . . . . . . . . . . .  43
  229.    View the output files . . . . . . . . . . . . . . . . . . . . . . . .  44
  230. Window menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  45
  231.    Size/Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  45
  232.    Zoom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  45
  233.    Tile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  45
  234.    Cascade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
  235.    Next. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
  236.    Previous. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
  237.    Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
  238. Help menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
  239.    Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
  240.    Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
  241.  
  242. INDEX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  47
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.                                        vi
  271.  
  272.                                     FIGURES
  273.  
  274. Figure  1: A ToolDriver window . . . . . . . . . . . . . . . . . . . . .  16
  275. Figure  2: View a File dialog box. . . . . . . . . . . . . . . . . . . .  21
  276. Figure  3: Change Directory dialog box . . . . . . . . . . . . . . . . .  23
  277. Figure  4: The Find Text dialog box. . . . . . . . . . . . . . . . . . .  27
  278. Figure  5: The Replace Text dialog box . . . . . . . . . . . . . . . . .  28
  279. Figure  6: Files to cross reference. . . . . . . . . . . . . . . . . . .  29
  280. Figure  7: The Cross reference files dialog. . . . . . . . . . . . . . .  32
  281. Figure  8: The Extended File Cross Reference Report  . . . . . . . . . .  34
  282. Figure  9: The Extended Word Usage Report. . . . . . . . . . . . . . . .  35
  283. Figure 10: The Unreferenced Files Report . . . . . . . . . . . . . . . .  36
  284. Figure 11: The Condensed File Cross Reference Report . . . . . . . . . .  36
  285. Figure 12: The Condensed Word Usage Report . . . . . . . . . . . . . . . 37A
  286. Figure 13: The File Parts List Report. . . . . . . . . . . . . . . . . . 37A
  287. Figure 14: The Export File . . . . . . . . . . . . . . . . . . . . . . . 37A
  288. Figure 15: NameChanger Files dialog. . . . . . . . . . . . . . . . . . .  41
  289. Figure 16: The Change names dialog . . . . . . . . . . . . . . . . . . .  43
  290. Figure 17: View the name-changed files dialog box  . . . . . . . . . . .  45
  291.  
  292.  
  293.  
  294.                                      TABLES
  295.  
  296. Table 1: General hot keys. . . . . . . . . . . . . . . . . . . . . . . .  12
  297. Table 2: Menu hot keys . . . . . . . . . . . . . . . . . . . . . . . . .  13
  298. Table 3: Editing hot keys. . . . . . . . . . . . . . . . . . . . . . . .  14
  299. Table 4: Window management hot keys. . . . . . . . . . . . . . . . . . .  14
  300. Table 5: Online help hot keys. . . . . . . . . . . . . . . . . . . . . .  14
  301. Table 6: How to use windows. . . . . . . . . . . . . . . . . . . . . . .  17
  302. Table 7: Export file flags . . . . . . . . . . . . . . . . . . . . . . .  39
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.                                        vii
  330. Preface
  331. ────────────────────────────────────────────────────────────────────────────
  332. Welcome to this user guide to ToolDriver. It describes how you can better
  333. organize your files and names. This information will be useful to anyone
  334. responsible for developing, managing, or maintaining application software.
  335.  
  336. You will learn:
  337. ■ The value of understanding the relationships of your source files.
  338.  
  339. ■ How planning your naming conventions can assist in debugging.
  340.  
  341. ■ How to uncover obsolete components.
  342.  
  343. ■ An easy way to change old programs to your current naming style.
  344.  
  345. ■ Organizing tricks that eliminate entire classes of problems.
  346.  
  347. ■ Characteristics of a well organized application.
  348.  
  349. ■ Ways to prevent unanticipated naming problems.
  350.  
  351. Software applications require careful planning and thoughtful
  352. implementation. The information provided here will help you understand the
  353. detailed organization of your application as well as communicate that
  354. understanding to others, making your job easier.
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.                                        8
  389. SECTION 1: Introduction
  390. ────────────────────────────────────────────────────────────────────────────
  391.  
  392. What's in ToolDriver?
  393. ■ An integrated window environment for running the ConVal programming
  394.   tools below.
  395.  
  396. ■ FileXref - cross references your files and names. It reads text
  397.   files and documents their use of other files and words you've
  398.   selected. It works on many languages including C, C++, Pascal,
  399.   COBOL, BAS, MASM, SQL, Fortran, and xBase.
  400.  
  401. ■ NameChanger - transforms names in the files associated with your
  402.   application.
  403.  
  404.  
  405. ■  See the file PACKLIST.DOC for a short description of each file supplied
  406. with ToolDriver.
  407.  
  408. Hardware and software requirements
  409. ToolDriver runs on machines with an 80286 or higher processor and running
  410. DOS 3.1 or higher. A hard disk, at least one floppy drive, and 2 megabytes
  411. of RAM are required to run ToolDriver. It uses 1.4 megabytes of hard disk
  412. space.
  413.  
  414. ToolDriver supports (but does not require) any Windows-compatible mouse.
  415. Microsoft Windows is not required
  416.  
  417. How to contact ConVal Software
  418. ConVal Software, Inc.
  419. 11607 E. Butter Creek Road
  420. Moorpark, CA 93021-2412
  421.  
  422. Sales and
  423. technical support:        Monday - Friday
  424.  
  425. Voice      (805) 529-6847 9 AM - 5 PM Pacific Time
  426. Fax        (805) 529-4314
  427. CompuServe     72330,1621
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.                                        9
  448. The ToolDriver package
  449. Your ToolDriver package consists of an installation disk and a ToolDriver
  450. User's Guide (this document). The disk contains all the programs and files
  451. you need to cross reference your source files and make changes to your
  452. naming conventions.
  453.  
  454.  
  455. SECTION 2: Installing ToolDriver
  456. ────────────────────────────────────────────────────────────────────────────
  457.  
  458. The ToolDriver installation procedure will verify that you have enough
  459. space on your hard drive, create directories as needed and transfer files
  460. from your distribution diskettes to your hard disk. Its actions are self-
  461. explanatory; the following instructions tell you all you need to know.
  462.  
  463. To install ToolDriver:
  464. 1.   Insert the installation disk into drive A. Type the following
  465.      command, then press Enter.
  466.         A:INSTALL
  467.  
  468. 2.   Press Enter again when the installation program displays its
  469.      initial screen.
  470.  
  471. 3.   Follow the installation prompts.
  472.  
  473. 4.   At the end of installation, you may want to add this line to your
  474.      CONFIG.SYS file:
  475.         FILES=20
  476.  
  477. Running ToolDriver
  478. Once you've installed ToolDriver, and if you're anxious to get up and
  479. running, change to the TOOLDRIV directory (if you didn't pick another name
  480. yourself), type TD and press Enter.
  481. Use the help key, F1, to learn about ToolDriver as you use it.
  482.  
  483. Otherwise, continue reading this documentation to see what ToolDriver does.
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.                                        10
  507. SECTION 3: ToolDriver Basics
  508. ────────────────────────────────────────────────────────────────────────────
  509. The ToolDriver platform for organizing files and names was developed using
  510. Borland's Turbo Vision for C++. It has everything you need to setup, run,
  511. view and print output from cross referencing as well as name-changing
  512. functions.
  513.  
  514. It provides:
  515. ■ multiple resizable windows that can be moved
  516. ■ mouse support and dialog boxes
  517. ■ cut, paste, and copy commands using a clipboard
  518. ■ a small, fast editor for preparing and revising input files
  519. ■ online Help
  520. ■ quick access to other programs and back again
  521.  
  522. This section explains the following topics:
  523. ■ starting and exiting ToolDriver
  524. ■ working with windows
  525. ■ using dialog boxes to communicate with ToolDriver
  526.  
  527. Starting ToolDriver
  528. To start ToolDriver, go to the ToolDriver directory ( C:\TOOLDRIV by
  529. default ), type TD and press Enter at the DOS prompt.
  530.  
  531. Exiting ToolDriver
  532. There are two ways to leave ToolDriver:
  533. ■ Choose File│Quit to leave ToolDriver completely; you have to type
  534.   TD again to reenter it. You'll be prompted to save your work before
  535.   exiting, if you haven't already done so.
  536.  
  537. ■ Choose File│DOS Shell to shell out from ToolDriver to enter
  538.   commands at the DOS command line. When you're ready to return to
  539.   ToolDriver, type EXIT at the command line and press Enter. You will
  540.   be able to resume work just as you left it.
  541.  
  542. The User Interface
  543. ToolDriver has three visible objects: a menu bar at the top of the screen,
  544. a window area in the middle, and a status line at the bottom of the screen.
  545.  
  546. If you are already familiar with the Borland IDE interface, then you may
  547. want to skip the rest of this section and read the sections on cross
  548. referencing (See FileXref, page 29) and changing names (See NameChanger,
  549. Page 40.
  550.  
  551. Selection of some menu commands will make a dialog box visible. There are
  552. several methods for selecting commands, but regardless of the method, the
  553. end result is the same.
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.                                        11
  566. The menu bar and menus
  567. The menu bar is your primary access to all the commands on the menu. It is
  568. always visible except when you're viewing your program's output or
  569. transferring to another program.
  570.  
  571. Here is how you choose menu commands using the keyboard:
  572.  
  573. 1.   Press F10. This makes the menu bar active. The next thing you type
  574.      will relate to items on the menu bar.
  575.  
  576. 2.   Use the left and right arrow keys to select the menu you want to
  577.      display. Then press Enter.
  578.  
  579.      As a shortcut for this step, you can just press the highlighted
  580.      letter of the menu title. For example, when the menu bar is active
  581.      press N to move to and display the NameChanger menu.
  582.  
  583.      A third way of doing this step is to hold down the Alt key and then
  584.      press a highlighted letter from the menu bar titles (such as Alt+N)
  585.      to display the menu you want.
  586.  
  587. 3.   Use the up and down arrows now to select a command from the menu
  588.      displayed.
  589.  
  590. At this point ToolDriver either carries out the command or displays a
  591. dialog box.
  592.  
  593. There are two ways to choose menu commands with a mouse:
  594.  
  595. 1.   Click the desired menu title to display the menu and click the
  596.      desired command from the menu.
  597.  
  598. 2.   Or, drag straight from the menu title down to the menu command.
  599.      Release the mouse button on the command you want. (If you change
  600.      your mind, just drag off the menu and no command will be chosen.)
  601.  
  602. Some menus and menu commands are unavailable when it would make no sense to
  603. choose them.
  604.  
  605. Following are lists of keyboard shortcuts (or hot keys) for accessing the
  606. menu bar, choosing menu commands, and working with dialog boxes.
  607.  
  608. Table 1: General hot keys
  609.  
  610. Hot Key     Menu command     Function
  611. ───────     ────────────     ──────────────────────────────────────────
  612. F1          Help             Displays a context-sensitive help screen.
  613.  
  614. F2          File│View        Brings up a dialog box for viewing a file.
  615.  
  616. F4          Window│Close     Closes the active window.
  617.  
  618. F5          Window│Zoom      Toggles the active window's size.
  619.  
  620. F10         (none)           Takes you to the menu bar.
  621.  
  622.  
  623.  
  624.                                        12
  625. Table 2: Menu hot keys
  626.  
  627. Hot Key          Menu          Function
  628. ────────────     ───────       ────────────────────────────────────────
  629. Alt+Spacebar     ≡             Takes you to the ≡(Product Info) menu.
  630.  
  631. Alt+E            Edit          Takes you to the Edit menu.
  632.  
  633. Alt+F            File          Takes you to the File menu.
  634.  
  635. Alt+H            Help          Takes you to the Help menu.
  636.  
  637. Alt+N            NameChanger   Takes you to the NameChanger menu.
  638.  
  639. Alt+S            Search        Takes you to the Search menu.
  640.  
  641. Alt+W            Window        Takes you to the Window menu.
  642.  
  643. Alt+X            FileXref      Takes you the the FileXref menu.
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671.  
  672.  
  673.  
  674.  
  675.  
  676.  
  677.  
  678.  
  679.  
  680.  
  681.  
  682.  
  683.                                        13
  684. Table 3: Editing hot keys
  685.  
  686. Hot Key      Command       Function
  687. ───────      ──────────    ────────────────────────────────────────────
  688. Ctrl+Ins     Edit Copy     Copies selected text to the
  689.                            clipboard.
  690.  
  691. Shift+Del    Edit Cut      Places selected text in the
  692.                            clipboard, deletes selected
  693.                            text.
  694.  
  695. Shift+Ins    Edit Paste     Pastes text from the clipboard
  696.                             into the active window.
  697.  
  698. Ctrl+Del     Edit Clear     Removes selected text from a
  699.                             window, but doesn't put it in
  700.                             the clipboard.
  701.  
  702. Ctrl+L       Search/Search  Repeats the last find or
  703.                             replace.
  704.  
  705. F3           File Save      Saves the file in the active edit
  706.                             window.
  707.  
  708. Table 4: Window management hot keys
  709.  
  710. Hot Key    Menu Command       Function
  711. ───────    ─────────────      ─────────────────────────────────────────
  712. Alt+n      (none)             Displays window n, where n is
  713.                               the number of the window you
  714.                               want to see.
  715.  
  716. F4          Window Close      Closes the active window.
  717.  
  718. F5          Window Zoom       Toggles the size of the active
  719.                               window.
  720.  
  721. Ctrl+F5     Window Size/Move  Changes the size or position
  722.                               of the active window.
  723.  
  724. F6          Window Next       Makes the next window the
  725.                               active one.
  726.  
  727. Shift+F6    Window Previous   Makes the prior window the
  728.                               active one.
  729.  
  730. Table 5: Online help hot keys
  731.  
  732. Hot Key     Function
  733. ───────     ──────────────────────────────────────
  734. F1          Opens a context-sensitive help screen.
  735.  
  736. Alt+F1      Displays the previous help screen.
  737.  
  738.  
  739.  
  740.  
  741.  
  742.                                        14
  743. Working with windows
  744. Most of what you see and do in ToolDriver happens in a window. A window is
  745. a screen area that you can open, close, move, resize, zoom, tile, and
  746. overlap.
  747.  
  748. You can have many windows open in ToolDriver, but only one window can be
  749. active at any time. Any menu command you choose or text you type generally
  750. applies only to the active window.
  751.  
  752. You can easily spot the active window - it's the one with the double-lined
  753. border around it. The active window always has a close box, a zoom box, and
  754. scroll bars. If your windows are overlapping, the active window is always
  755. on top of all the others.
  756.  
  757. There are several types of windows, but most of them have these things in
  758. common:
  759. ■ a title bar
  760. ■ a close box
  761. ■ scroll bars
  762. ■ a zoom box
  763. ■ a window number (1 to 9)
  764.  
  765. An edit window also displays the current line and column numbers in the
  766. lower left corner. If you've modified your file, an asterisk (*) appears to
  767. the left of the column and line numbers.
  768.  
  769. The following figure shows a typical window:
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787.  
  788.  
  789.  
  790.  
  791.  
  792.  
  793.  
  794.  
  795.  
  796.  
  797.  
  798.  
  799.  
  800.  
  801.                                        15
  802. Figure  1: A ToolDriver window
  803.  
  804.                 ┌────────────────────────┐
  805.                 │ The title bar contains │
  806.                 │ the name of the window │
  807.                 └───────────┬────────────┘
  808.                             │
  809.  ┌───────────────┐          │      ┌───────────────────────┐
  810.  │ Click the     │          │      │ Click on the zoom box │
  811.  │ close box to  │          │      │ to either enlarge or  │
  812.  │ quickly close │          │      │ shrink the window     │
  813.  │ the window    │          │      └─────────────┬─────────┘
  814.  └──────┬────────┘          │                    │
  815.         │                   │                    │
  816.                                                
  817. ┌─ ╔══[■}════════════ Window Title ════════ 4 ═[■]══╗ ─┐
  818. │   ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║   │
  819. │   ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░   │
  820. │   ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│░░░░░░░▓   │
  821. │   ║░░░░░░░░░░░░░░░░░░░┌────────────────────┴────┐░░▓   │
  822. │   ║░░░░░░░░░░░░░░░░░░░│ The first 9 open        │░░▓   │
  823. │   ║░░░░░░░░░░░░░░░░░░░│ windows have a window   │░░■   │
  824. │   ║░░░░░░░░░░░░░░░░░░░│ number. Use Alt and n   │░░▓   │
  825. │   ║░░░░░░░░░░░░░░░░░░░│ to make window n active │░░▓   │
  826. │   ║░░░░░░░░░░░░░░░░░░░└─────────────────────────┘░░▓   │
  827. │   ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓   │
  828. │   ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓   │
  829. │   ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓   │
  830. │   ║░░░░░░░░┌───────────────────────────┐░░░░░░░░░░░▓   │
  831. │   ║░░░░░░░░│ Use a mouse to scroll the ├─────────░▓   │
  832. │   ║░░░░░░░░│ contents of the window    │░░░░░░░░░░░▓   │
  833. │   ║░░░░░░░░└─────────┬─────────────────┘░░░░░░░░░░░▓   │
  834. │   ║░░░░░░░░░░░░░░░░░░│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓   │
  835. │   ║░░░░░░░░░░░░░░░░░░│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓   │
  836. │   ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░   │
  837. │   ╚═▓▓▓▓▓▓▓▓▓■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓─┘   │
  838. │                                                      │
  839. │   │            ┌────────────────────────────┐      │   │
  840. └───┴────────────│ Drag any corner to make    │──────┴───┘
  841.                  │ windows larger or smaller. │
  842.                  └────────────────────────────┘
  843.  
  844. The close box of a window is the box in the upper left corner. Click this
  845. box to quickly close the window. (Or choose Window│Close.) The help windows
  846. are considered temporary. You can close them by pressing Esc.
  847.  
  848. The title bar, the topmost horizontal bar of a window, contains the name of
  849. the window and the window number. Double-clicking the title bar zooms the
  850. window. You can also drag the title bar to move the window around.
  851.  
  852.  
  853.  
  854.  
  855.  
  856.  
  857.  
  858.  
  859.  
  860.                                        16
  861. The zoom box of a window appears in the upper right corner. If the icon in
  862. that corner is an up arrow (), you can click the arrow to enlarge the
  863. window to the largest possible size. If the icon is a double-headed arrow
  864. (), the window is already at its maximum size. In that case, clicking it
  865. returns the window to its previous size. To zoom a window from the
  866. keyboard, choose Window│Zoom.
  867.  
  868. The first nine windows you open in ToolDriver have a window number in the
  869. upper right border. You can make a window active (and bring it to the top)
  870. by pressing Alt and the window number. For example if the FileXref output
  871. report window is window number 4 and it's behind other windows, then Alt+4
  872. brings it to the top so it's fully visible.
  873.  
  874. Scroll bars are horizontal or vertical bars that look like this:
  875.  
  876. ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
  877.  
  878. Scroll bars show you where you are in relation to what you're viewing. You
  879. use these bars with a mouse to scroll the contents of the window. Click the
  880. arrow at either end to scroll one line at a time. (Keep the mouse button
  881. pressed to scroll continuously.) You can click the shaded area to either
  882. side of the scroll box to scroll a page at a time.
  883.  
  884. Finally, you can drag the scroll box to any spot on the bar to quickly move
  885. to a spot in the window relative to the position of the scroll box.
  886.  
  887. You can drag any corner to make a window larger or smaller. To resize from
  888. the keyboard, choose Size/Move from the Window menu. Press enter when
  889. finished to get out of the sizing/moving mode.
  890.  
  891. Table 6 is a quick reference for using windows in ToolDriver. Note that you
  892. don't need a mouse to perform these actions - a keyboard works fine too.
  893.  
  894. Table 6: How to use windows
  895.  
  896. To do this                Use one of these techniques
  897. ──────────────────────    ─────────────────────────────────────────────
  898. Open a file viewer        Choose File View to open a
  899.                           file and scroll it in a
  900.                           window.
  901.  
  902. Open other windows        Choose the desired window from
  903.                           the Window menu.
  904.  
  905. Close a window            Choose Close from the Window
  906.                           menu or click the close box of
  907.                           the window or press F4.
  908.  
  909. Activate a window         Click anywhere in the window,
  910.                           or
  911.  
  912.  
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.                                        17
  920.  
  921. To do this                Use one of these techniques
  922. ──────────────────────    ─────────────────────────────────────────────
  923.                           Press Alt plus the window
  924.                           number (1 to 9), or
  925.  
  926.                           Choose Window Next (F6 is the
  927.                           hot key) to step through the
  928.                           windows in the order you
  929.                           created them, or
  930.  
  931.                           Choose Window Previous
  932.                           (Shift+F6 is the hot key) to
  933.                           step through the windows in
  934.                           the reverse of the order you
  935.                           created them.
  936.  
  937. Move an active window     Drag its title bar. Or choose
  938.                           Window Size/Move and use the
  939.                           arrow keys to place the window
  940.                           where you want it, then press
  941.                           Enter.
  942.  
  943. Resize the active window  Drag any corner. Or choose
  944.                           Window Size/Move and press
  945.                           Shift while you use the arrow
  946.                           keys to resize the window,
  947.                           then press Enter.
  948.  
  949. Zoom the active window    Click the zoom box in the
  950.                           upper right corner of the
  951.                           window, or
  952.  
  953.                           Double-click the window's
  954.                           title bar, or
  955.  
  956.                           Choose Window Zoom (F5 is the
  957.                           hot key).
  958.  
  959.  
  960.  
  961. The status line
  962. The status line appears at the bottom of the screen to
  963. ■ remind you of basic keystrokes and shortcuts (or hot keys)
  964.   applicable in the active window.
  965. ■ let you use the mouse to click on a command to perform the action
  966.   instead of choosing the action from the menu or pressing the
  967.   shortcut keystroke.
  968.  
  969. Here is what the status line looks like:
  970.  
  971. ┌───────────┬───────────────────────────────────────────┬──┐
  972. │ToolDriver │ F1 Help F2 View F4 Close F5 Zoom F10 Menu │Id│
  973. └───────────┴───────────────────────────────────────────┴──┘
  974.  
  975. Where Id is the serial number of your registered software.
  976.  
  977.  
  978.                                        18
  979. Dialog boxes
  980. A menu command with an ellipsis (...) after it leads to a dialog box.
  981. Dialog boxes offer a convenient way to view and set multiple options. When
  982. you're making settings in dialog boxes, you work with five basic types of
  983. onscreen controls: action buttons, radio buttons, check boxes, input boxes,
  984. and list boxes.
  985.  
  986. Action buttons
  987. │  OK     │
  988.  
  989.  │  Cancel │
  990.  
  991. Above are two action buttons, OK and Cancel. If you choose OK, the choices
  992. in the dialog box are accepted; if you choose Cancel, nothing changes, no
  993. action takes place, and the dialog box is put away. Choose Help to open a
  994. Help window about this dialog box. Esc is always a keyboard shortcut for
  995. Cancel (even if no Cancel button appears).
  996.  
  997. If you're using a mouse, click the dialog-box button you want. When you're
  998. using the keyboard, press Alt and the highlighted letter of a command to
  999. activate it. For example Alt+C selects the Cancel button because the C in
  1000. Cancel is highlighted. Press Tab or Shift+Tab to move forward or back from
  1001. one item to another in a dialog box. Each element is highlighted when it
  1002. becomes active.
  1003.  
  1004. In this dialog box, OK is the default button, which means you need only
  1005. press Enter to choose the button. (On monochrome systems, arrows indicate
  1006. the default; on color monitors, default buttons are highlighted.) Be aware
  1007. that tabbing to a button makes that button the default.
  1008.  
  1009. Radio Buttons and check boxes
  1010. ┌───────────────────────────────────┐
  1011. │ Radio Buttons        Check Boxes  │
  1012. │ ( ) Option 1         ( ) Option A │
  1013. │ (X) Option 2         (X) Option B │
  1014. │ ( ) Option 3         ( ) Option C │
  1015. │                      (X) Option D │
  1016. └───────────────────────────────────┘
  1017.  
  1018. Radio buttons are like car-radio buttons. They come in groups, and only one
  1019. radio button in the group can be on at any one time. To choose a radio
  1020. button, click it or its text. From the keyboard, select Alt and the
  1021. highlighted letter, or press Tab until the group is highlighted, and then
  1022. use the arrow keys to choose a particular radio button. Press Tab or
  1023. Shift+Tab again to leave the group with the new radio button chosen.
  1024. Section 1 Check boxes differ from radio buttons in that you can have any
  1025. number of check boxes checked at any time. When you select a check box, an
  1026. X appears in it to show you it's on. An empty box indicates it's off. To
  1027. change the status of a check box, click it or its text, press Tab until the
  1028. check box is highlighted and then press Spacebar, or select Alt plus the
  1029. highlighted letter.
  1030.  
  1031.  
  1032.  
  1033.  
  1034.  
  1035.  
  1036.  
  1037.                                        19
  1038. If several check boxes apply to a topic, they appear as a group. In that
  1039. case, tabbing moves to the group. Once the group is selected, use the arrow
  1040. keys to select the item you want, and then press Spacebar to check or
  1041. uncheck it. On monochrome monitors, the active check box or group of check
  1042. boxes will have a chevron symbol (») to the left and right. When you press
  1043. Tab, the chevrons move to the next group of check boxes or radio buttons.
  1044.  
  1045. Input boxes and list boxes
  1046. Input boxes let you type in text. Most basic text-editing keys work in the
  1047. text box (for example, arrow keys, Home, End, and Ins). If you continue to
  1048. type once you reach the end of the box, the contents automatically scroll.
  1049. If there's more text than shows in the box, arrowheads appear at the end (
  1050. and ). You can click the arrowheads to scroll or drag the text. If you
  1051. need to enter control characters (such as ^L or ^M) in the input box, then
  1052. prefix the character with a ^P. So, for example, to enter ^M into the input
  1053. box, hold down the Ctrl key and press PM. (This capability is useful for
  1054. search strings.)
  1055.  
  1056. If an input box has a down-arrow icon to its right, there is an associated
  1057. history list. Click the icon to display the list. You'll find text you
  1058. typed the last few times you used the input box. Press Enter to choose an
  1059. item from this list. The Find box, for example, has such a history list,
  1060. which keeps track of the text you searched for previously. Try choosing a
  1061. previous search string. You can also edit an entry in the history list.
  1062. Press Esc to exit from the history list without making a selection.
  1063.  
  1064. A final component of many dialog boxes is a list box, which lets you scroll
  1065. through and select from variable-length lists (often file names) without
  1066. leaving a dialog box. If a blinking cursor appears in the list box and you
  1067. know what you're looking for, you can type the word (or the first few
  1068. letters of the word) and ToolDriver will search for it.
  1069.  
  1070. You make a list box active by clicking it or by choosing the highlighted
  1071. letter of the list title (or press Tab until it's highlighted). Once a list
  1072. box is displayed, you can use the scroll box to move through the list or
  1073. press the up and down arrows from the keyboard.
  1074.  
  1075.  
  1076. SECTION 4: Menus and options reference
  1077. ────────────────────────────────────────────────────────────────────────────
  1078.  
  1079. This section provides a reference to each ToolDriver menu option. It's
  1080. arranged in the order that the menus appear on the screen. For information
  1081. on starting and exiting ToolDriver, and general information on how the user
  1082. interface works, see Section 1.
  1083.  
  1084. Next to some of the menu option descriptions in this reference you'll see
  1085. keyboard shortcuts, or hot keys.
  1086.  
  1087. ≡ (System) menu  Alt+Spacebar
  1088. The ≡ menu appears on the far left of the menu bar. Alt+Spacebar is the
  1089. fastest way to get there. When you pull down the menu (by using the down
  1090. arrow) you see two commands, Register and Product Information.
  1091.  
  1092. Register
  1093. Choose ≡│Register to print a ToolDriver Registration form. A file print
  1094. dialog will be presented, with the file REGISTER.DOC selected. Just press
  1095. enter to print the registration form.
  1096.                                        20
  1097. Product Information
  1098. The ≡│Product Information menu command displays the version of ToolDriver
  1099. you are running. The same information displays when you initially bring up
  1100. ToolDriver. Put this information away by pressing enter.
  1101.  
  1102. File menu  Alt+F
  1103. The file menu lets you open and view files in a file viewer window. It also
  1104. lets you print files, change the working directory, shell to DOS and exit
  1105. the ToolDriver environment.
  1106.  
  1107. View F2
  1108. The File│View command displays a file-selection dialog box for you to
  1109. select a text file to open in a file viewer window. Here is what the box
  1110. looks like:
  1111.  
  1112. Figure  2: View a File dialog box
  1113.  
  1114. ╔══[■}═════════════════ View a File ═══════════════════╗
  1115. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1116. ║░░ Name░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1117. ║░░░ *.*                              ░░░░░ Open  ░░║
  1118. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1119. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1120. ║░░ Files                               ░░░░░░░░░░░░░░░║
  1121. ║░░░ CRE8FSL.EXE       │  FILEXREF.WSL  ░░░░  Cancel ░░║
  1122. ║░░░ FILELIST.EXE      │  FILEXREF.XRF  ░░░░░░░░░░░░░░░║
  1123. ║░░░ FILEXREF.BAK      │  HISTORY.DOC   ░░░░░░░░░░░░░░░║
  1124. ║░░░ FILEXREF.EXE      │  NAMEC.EXE     ░░░░░░░░░░░░░░░║
  1125. ║░░░ FILEXREF.FEI      │  NAMEC.FSL     ░░░░░░░░░░░░░░░║
  1126. ║░░░ FILEXREF.FSL      │  NAMEC.MSG     ░░░░░░░░░░░░░░░║
  1127. ║░░░ FILEXREF.MSG      │  NAMEC.SRL     ░░░░░░░░░░░░░░░║
  1128. ║░░░»FILEXREF.PRN«     │  \WORK         ░░░░░░░░░░░░░░░║
  1129. ║░░░ ■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓     ░░░░░░░░░░░░░░░║
  1130. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1131. ║░░░C:\TOOLDRIV\*.*                                    ║
  1132. ║░░░FILEXREF.PRN 133153          Jun 01,1993   09:15a  ║
  1133. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1134. ╚══════════════════════════════════════════════════════╝
  1135.  
  1136. The dialog box contains an input box, a file list, buttons labeled, Open
  1137. and Cancel, and an information panel that describes the selected file. Now
  1138. you can do any of these actions:
  1139. ■ Type in a full file name and choose Open. Open loads the file into
  1140.   a file viewer window.
  1141.  
  1142. ■ Type in a file name with wildcards, which filters the file list to
  1143.   match your specifications.
  1144.  
  1145. ■ Press  to choose a file specification from a history list of file
  1146.   specifications you've entered earlier.
  1147.  
  1148. ■ View the contents of different directories by selecting a directory
  1149.   name in the file list.
  1150.  
  1151. The input box lets you enter a file name explicitly or enter a file name
  1152. with standard DOS wildcards (* and ?) to filter the names appearing in the
  1153. history list box. If you enter the entire name and press enter, ToolDriver
  1154. opens it for viewing.
  1155.                                        21
  1156. If you press  when the cursor is blinking in the input box, a history list
  1157. drops down below
  1158. the box. This list displays the last 15 file names or file name masks
  1159. you've entered. Choose a name from the list by double-clicking it or
  1160. selecting it with the arrow keys and pressing Enter.
  1161.  
  1162. Once you've typed in or selected the file you want, choose the Open button
  1163. (choose Cancel if you change your mind). You can also just press Enter once
  1164. the file is selected, or you can double-click the file name in the file
  1165. list.
  1166.  
  1167. Using the file list box
  1168. The File list box displays all file names in the current directory that
  1169. match the specifications in the input box, displays the parent directory,
  1170. and displays all subdirectories. Click the list box or press Tab until the
  1171. list box name is highlighted. You can now press  or  to select a filename
  1172. and then press Enter to open it. You can also double-click any file name in
  1173. the box to open it. You might have to scroll the box to see all the names.
  1174. If you have more than one panel of names, you can also use the left and
  1175. right arrows.
  1176.  
  1177. The file information panel at the bottom of the View a file dialog box
  1178. displays path name, file name, date, time and size of the file you've
  1179. selected in the list box. As you scroll through the list box, the panel is
  1180. updated for each file.
  1181.  
  1182. Print
  1183. The File│Print command displays a file-selection dialog box for you to
  1184. select a text file to be printed. It looks and functions like the File│View
  1185. command except that the output will be routed to your printer instead of a
  1186. file viewer. Use this option to print the report file (FILEXREF.PRN)
  1187. produced by the FileXref tool.
  1188.  
  1189. Change Dir
  1190. The File│Change Dir command lets you specify a drive and a directory to
  1191. make current. The current directory is the one ToolDriver uses for viewing
  1192. and printing files. Note that choices on the FileXref and NameChanger menus
  1193. will always reset the current directory to the ToolDriver installation
  1194. directory, where its control files reside.
  1195.  
  1196. The Change Directory dialog box looks like is shown on the next page:
  1197.  
  1198.  
  1199.  
  1200.  
  1201.  
  1202.  
  1203.  
  1204.  
  1205.  
  1206.  
  1207.  
  1208.  
  1209.  
  1210.  
  1211.  
  1212.  
  1213.  
  1214.                                        22
  1215. Figure  3: Change Directory dialog box
  1216.  
  1217. ╔══[■}═══════════════ Change Directory ════════════════╗
  1218. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1219. ║░░ Directory Name ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1220. ║░░░ C:\TOOLDRIV                      ░░░░░░░░░░░░░░░░║
  1221. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1222. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1223. ║░░ Directory Tree                      ░░░░░░░░░░░░░░░║
  1224. ║░░░ Drives                             ░░░░  OK     ░░║
  1225. ║░░░        C:\                   ▓     ░░░░░░░░░░░░░░░║
  1226. ║░░░        └─TOOLDRIV            ▓     ░░░░  Chdir  ░░║
  1227. ║░░░          └─WORK              ▓     ░░░░░░░░░░░░░░░║
  1228. ║░░░                              ▓     ░░░░  Revert ░░║
  1229. ║░░░                              ▓     ░░░░░░░░░░░░░░░║
  1230. ║░░░                              ■     ░░░░░░░░░░░░░░░║
  1231. ║░░░                                    ░░░░░░░░░░░░░░░║
  1232. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1233. ╚══════════════════════════════════════════════════════╝
  1234.  
  1235.  
  1236. There are two ways to change directories:
  1237. ■ Type in the path of the new directory in the input box and press Enter
  1238.  
  1239. ■ Choose the directory you want in the directory tree (if you're using
  1240.   the keyboard, press  Enter to make it the current directory), then
  1241.   choose OK or press Esc.
  1242.  
  1243. If you choose the OK button, your changes are made and the dialog box is
  1244. closed. If you choose the Chdir button, the Directory Tree list box changes
  1245. to the selected directory and displays the subdirectories of the currently
  1246. highlighted directory (pressing Enter or double-clicking on that entry
  1247. gives you the same result). If you change your mind about the directory
  1248. you've picked and you want to go back to the previous one (and you've yet
  1249. to exit the dialog box), choose the Revert button.
  1250.  
  1251. Running commands under the FileXref and NameChanger menus automatically
  1252. changes the directory to the ToolDriver installation directory where their
  1253. program and help files reside.
  1254.  
  1255. DOS Shell
  1256. The File│DOS Shell command lets you temporarily exit ToolDriver to enter a
  1257. DOS command or program. To return to ToolDriver, type EXIT and press Enter.
  1258.  
  1259. Don't install any TSR programs (like SideKick) or print a file with the DOS
  1260. print command while you've shelled to DOS, because memory may be
  1261. misallocated.
  1262.  
  1263.  
  1264.  
  1265.  
  1266.  
  1267.  
  1268.  
  1269.  
  1270.  
  1271.  
  1272.  
  1273.                                        23
  1274. Quit    Alt+Q
  1275. The File│Quit command exits ToolDriver and removes it from memory. If you
  1276. have made any changes you haven't saved, ToolDriver asks if you want to
  1277. save them before exiting.
  1278.  
  1279. Edit menu     Alt+E
  1280. The Edit menu lets you cut, copy, and paste text in edit windows. You can
  1281. also open a Clipboard window to view or edit its contents. This window is
  1282. also used to edit the file extension control table.
  1283.  
  1284. An edit window is only created by ToolDriver, to support the creation and
  1285. modification of input files it requires. Edit (and Search) menu commands
  1286. are disabled otherwise.
  1287.  
  1288. File edit windows are presented in these cases:
  1289. ■ when you choose the Edit│File Extensions option (This allows you to
  1290.   modify the list of rules for associating file extensions to the
  1291.   source language types
  1292.    they contain.)
  1293.  
  1294. ■ after processing the FileXref│Generate dialog (This allows you to
  1295.   modify the list of files to be cross referenced.)
  1296.  
  1297. ■ after choosing the FileXref│Edit command (This allows you to modify
  1298.   a list of words to be cross referenced.) (You do not need to list
  1299.   the names of any files here - they are automatically cross
  1300.   referenced.)
  1301.  
  1302. ■ after processing the NameChanger│Generate dialog (This allows you
  1303.   to modify the list of files to be name-changed.)
  1304.  
  1305. ■ after choosing the NameChanger│Edit command (This allows you to
  1306.   specify the names to be changed and what they are to be changed
  1307.   to.) (Names may be file names; variable names; i.e. any complete
  1308.   symbol)
  1309.  
  1310. Before you can use most of the commands on the edit menu, you need to know
  1311. about selecting text (because most editor actions apply to selected text).
  1312. Selecting text means highlighting it. You can select text either with
  1313. keyboard commands or with a mouse; the principle is the same even though
  1314. the actions are different.
  1315.  
  1316. From the keyboard
  1317. ■ Press Shift while pressing any key that moves the cursor.
  1318.  
  1319. Using a mouse
  1320. ■ To select text with a mouse, drag the mouse pointer over the
  1321.   desired text. If you need to continue the selection past a window's
  1322.   edge, just drag off the side and the window automatically scrolls.
  1323.  
  1324.  
  1325.  
  1326.  
  1327.  
  1328.  
  1329.  
  1330.  
  1331.  
  1332.                                        24
  1333. ■ To select a single word, double-click it.
  1334. ■ To extend or reduce the selection, Shift-click anywhere in the
  1335.   document (that is, hold Shift and click). Once you've selected
  1336.   text, the Cut and Copy commands in the Edit menu become available.
  1337.  
  1338. The Clipboard is the magic behind cutting and pasting. It's a special
  1339. window that holds text you cut or copied, so you can paste it elsewhere.
  1340. The Clipboard works in close concert with the commands in the Edit menu.
  1341.  
  1342. The next few pages contain an explanation of each command in the Edit menu.
  1343.  
  1344. File Extension
  1345. The File Extension command brings up an edit box for you to define the
  1346. source file extensions you use and the type of data they contain. The name
  1347. of the file being edited is TOOLDRIV.EXT. It is a text file and may contain
  1348. two types of records:
  1349.  
  1350. 1.   Comments begin with two dashes "--".
  1351.  
  1352. 2.   File attribute records contain four columns each. They associate a
  1353.         file extension with the type of file it is. All extensions in this
  1354.         list should point to text files. Unpredictable results will occur
  1355.         with non-text files. The data is freeform ( where one blank is
  1356.         allowed, you may use several).
  1357.  
  1358.                       Column layout:
  1359.   ┌────────────────────────────────────────────────────────────┐
  1360.   │    1               2                   3             4     │
  1361.   ├───────────┬─────────────────────┬───────────────┬──────────┤
  1362.   │  file     │ f - fixed length    │   maximum     │  source  │
  1363.   │ extension │ v - variable length │ record length │ language │
  1364.   └───────────┴─────────────────────┴───────────────┴──────────┘
  1365.  
  1366. Following are the defaults provided at install time:
  1367.  
  1368.   Note that COBOL, FORTRAN, and PL/I need to be fixed length with 80
  1369.   character records.
  1370.  
  1371.  
  1372.  
  1373.  
  1374.  
  1375.  
  1376.  
  1377.  
  1378.  
  1379.  
  1380.  
  1381.  
  1382.  
  1383.  
  1384.  
  1385.  
  1386.  
  1387.  
  1388.  
  1389.  
  1390.  
  1391.                                        25
  1392. Ext     F/V   Length    Currently supported language codes
  1393.                         (enter these exactly as shown)
  1394. ───     ───   ────    ────────────
  1395. ASM     v     255     assembler
  1396. BAS     v     255     basic
  1397. BAT     v     255     batchFile
  1398. C       v     255     c/c++
  1399. CBL     v     255     cobol
  1400. COB     f     80      cobol
  1401. CPP     v     255     c/c++
  1402. DOC     v     255     textFile
  1403. FOR     f     80      fortran
  1404. H       v     255     c/c++
  1405. HPP     v     255     c/c++
  1406. INP     v     255     OracleForms
  1407. MAK     v     255     textFile
  1408. PAS     v     255     pascal
  1409. PLI     f     80      PL/I
  1410. PRG     v     255     xBase
  1411. REX     v     255     OracleSQLReportWriter
  1412. RPT     v     255     OracleRPT
  1413. SQL     v     255     OracleSQLScript
  1414. SQR     v     255     SQLSolutionsSQR
  1415. TXT     v     255     textFile
  1416.  
  1417. Change this file if you use other file extensions for the supported
  1418. language codes (or to cross reference other languages using one of these
  1419. parsers). So if you use Oracle's PRO*C (C code with embedded SQL) and use
  1420. the file extension .PC to distinguish these special files, then add the
  1421. following line.
  1422.  
  1423. PC   v  255   c/c++
  1424.  
  1425. Be sure to type the language code exactly as shown above.
  1426.  
  1427. Cut    Shift+Del
  1428. The Edit│Cut command removes the selected text from your document and
  1429. places the text in the Clipboard. You can then paste that text into any
  1430. other document (or somewhere else in the same document) by choosing Paste.
  1431. The text remains selected in the Clipboard so that you can paste the same
  1432. text many times.
  1433.  
  1434. Copy Ctrl+Ins
  1435. The Edit│Copy command leaves the selected text intact but places an exact
  1436. copy of it in the Clipboard. You can then paste that text into any other
  1437. document by choosing Paste.
  1438.  
  1439. Paste   Shift+Ins
  1440. The Edit│Paste command inserts from the Clipboard into the current edit
  1441. window at the cursor position. The text that is pasted is the currently
  1442. marked block in the Clipboard window.
  1443.  
  1444.  
  1445.  
  1446.  
  1447.  
  1448.  
  1449.  
  1450.                                        26
  1451. Show Clipboard
  1452. The Edit│Show Clipboard command opens the Clipboard window, which stores
  1453. the text you cut and copy from other windows. The text that's currently
  1454. selected (highlighted) is the text ToolDriver uses when you choose Paste.
  1455.  
  1456. You can think of the Clipboard window as a history list of your cuts and
  1457. copies. You can edit the Clipboard so that the text you paste is precisely
  1458. the text you want. ToolDriver uses whatever text is selected in the
  1459. Clipboard when you choose Paste.
  1460.  
  1461. The Clipboard window is just like other edit windows; you can move it,
  1462. resize it, and scroll and edit its contents. The only difference you'll
  1463. find in the Clipboard window is when you choose to cut or copy text. When
  1464. you select text in the Clipboard window and choose Cut or Copy, the
  1465. selected text immediately appears at the bottom of the window. (Remember,
  1466. any text you cut or copy is appended to the end of the Clipboard and
  1467. highlighted - so you can paste it later.
  1468.  
  1469. Search menu   Alt+S
  1470. The Search menu lets you search and replace text in edit windows.
  1471.  
  1472. Find    Ctrl+Q+F
  1473. The Search│Find command displays the Find Text dialog box, which lets you
  1474. type in the text you want to search for and set options that affect the
  1475. search.
  1476.  
  1477. Figure  4: The Find Text dialog box
  1478. ╔══[■}════════════  Find Text  ════════════════╗
  1479. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1480. ║░» Text to Find ░                         ░░░║
  1481. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1482. ║░░ Options                  ░░░░░░░░░░░░░░░░░░║
  1483. ║░░░ (X) Case Sensitive      ░░░░░░░░░░░░░░░░░░║
  1484. ║░░░ ( ) Whole words only    ░░░░░░░░░░░░░░░░░░║
  1485. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1486. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1487. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1488. ║░░░░░░░░░░░░░░░░░░░»  OK  «░░  Cancel  ░░░░░░░║
  1489. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1490. ╚══════════════════════════════════════════════╝
  1491.  
  1492. The Find Text dialog box contains several buttons and check boxes:
  1493.  
  1494. ┌────────────────────┐    Check the Case Sensitive box if
  1495. │ (X) Case sensitive │    you do want ToolDriver to
  1496. └────────────────────┘    differentiate uppercase from
  1497.                           lowercase.
  1498.  
  1499.  
  1500.  
  1501.  
  1502.  
  1503.  
  1504.  
  1505.  
  1506.  
  1507.  
  1508.  
  1509.                                        27
  1510. ┌──────────────────────┐  Check the Whole words Only box if
  1511. │ ( ) Whole words only │  you want ToolDriver to search for
  1512. └──────────────────────┘  whole words only. (that is, the
  1513.                           string must have punctuation or
  1514.                           space characters on both sides)
  1515.  
  1516. Replace Ctrl+Q+A
  1517.  
  1518. Following is the dialog for replacing text.
  1519.  
  1520. Figure  5: The Replace Text dialog box
  1521.  
  1522. ╔══[■}═════════  Replace Text  ════════════════╗
  1523. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1524. ║░» Text to Find ░                         ░░░║
  1525. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1526. ║░░░░░░ New Text ░                         ░░░║
  1527. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1528. ║░░ Options                  ░░░░░░░░░░░░░░░░░░║
  1529. ║░░░ (X) Case Sensitive      ░░░░░░░░░░░░░░░░░░║
  1530. ║░░░ ( ) Whole words only    ░░░░░░░░░░░░░░░░░░║
  1531. ║░░░ ( ) Prompt on replace   ░░░░░░░░░░░░░░░░░░║
  1532. ║░░░ ( ) Replace all         ░░░░░░░░░░░░░░░░░░║
  1533. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1534. ║░░░░░░░░░░░░░░░░░░░»  OK  «░░  Cancel  ░░░░░░░║
  1535. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1536. ╚══════════════════════════════════════════════╝
  1537.  
  1538. The Replace Text dialog box contains several radio buttons and check boxes
  1539. - many of which are identical to the Find Text dialog box, discussed
  1540. previously. An additional checkbox, Prompt on Replace, controls whether you
  1541. want to be prompted for each change.
  1542.  
  1543. Enter the search string and the replacement string in the input boxes and
  1544. choose OK to begin the search or Cancel to not do it. If you want to enter
  1545. a string you used previously, press  to show a history list to choose
  1546. from.
  1547.  
  1548. If ToolDriver finds the specified text and Prompt on Replace is on, it asks
  1549. you if you want to make the replacement. If you choose OK, it will find and
  1550. replace the first instance of the search item.
  1551.  
  1552. Search Again  Ctrl+L
  1553. The Search│Search Again command repeats the last Find or Replace command.
  1554. All settings you made in the last dialog box used (Find or Replace) remain
  1555. in effect when you choose Search Again.
  1556.  
  1557.  
  1558.  
  1559.  
  1560.  
  1561.  
  1562.  
  1563.  
  1564.  
  1565.  
  1566.  
  1567.  
  1568.                                        28
  1569. FileXref Menu  Alt+X
  1570. The FileXref menu item is the one to choose when you want to see how your
  1571. text files relate to one another. This option is also used to find the
  1572. global usage of words (data names, function names, table columns, language
  1573. verbs, etc.) throughout your source and documentation files. Any text files
  1574. may be cross referenced.
  1575.  
  1576. The menu item is named FileXref since it uses the ConVal FILEXREF.EXE
  1577. program to do the cross referencing.
  1578.  
  1579. There are four supporting options on this menu:
  1580. ■ Files to cross reference
  1581. ■ Words to cross reference
  1582. ■ Start cross referencing
  1583. ■ View the output log
  1584.  
  1585. A complete example of cross referencing will be provided, showing all
  1586. inputs and outputs.
  1587.  
  1588. Files to cross reference
  1589. Choose this menu option to identify which files you want cross referenced.
  1590. You can enter the list manually or have a ToolDriver utility do it for you.
  1591. The dialog box you use looks like this:
  1592.  
  1593. Figure  6: Files to cross reference
  1594.  
  1595. ╔══[■}══  Files to be cross referenced ══════════╗
  1596. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1597. ║░[X]  Generate a file list for me ░░░░░░░░░░░░░░║
  1598. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1599. ║░     using the directory tree starting with: ░░║
  1600. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1601. ║░»C:\PROJECT1                             ░░░░░║
  1602. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1603. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1604. ║░░░░░░░░░░░░░░░░░░░»  OK  «░░  Cancel  ░░░░░░░░░║
  1605. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1606. ╚════════════════════════════════════════════════╝
  1607.  
  1608.  
  1609. If you check the check box and enter a directory (as above), ToolDriver
  1610. will prepare a file list for you, using the TOOLDRIV.EXT control file (see
  1611. Page 25) where you defined the file extensions you use for source and
  1612. documentation. The list of file names will be written to file FILEXREF.FSL,
  1613. a file specification list. The list will include files in the directory
  1614. entered and in its subdirectories and their subdirectories (the directory
  1615. tree). To select from all files on a hard disk, say D, then enter D: as the
  1616. starting point.
  1617.  
  1618. Note: If you enter a file with an extension not listed in TOOLDRIV.EXT,
  1619. then it will be handled by default as a "textFile" language code.
  1620.  
  1621.  
  1622.  
  1623.  
  1624.  
  1625.  
  1626.  
  1627.                                        29
  1628. Check the check box and use the default directory of C:\TOOLDRIV to have a
  1629. file specification list like the following generated by ToolDriver:
  1630.  
  1631. ───────────────────────────────────────────────────
  1632. -- This is a file specification list for FILEXREF.
  1633. C:\TOOLDRIV\README.DOC
  1634. C:\TOOLDRIV\HISTORY.DOC
  1635. C:\TOOLDRIV\PACKLIST.DOC
  1636. C:\TOOLDRIV\REGISTER.DOC
  1637. ───────────────────────────────────────────────────
  1638.  
  1639. This is the list of files used in the sample reports.
  1640.  
  1641. There are two line types in the file specification list:
  1642.  
  1643. 1. Comment lines contain "--" in the first two columns.
  1644.  
  1645. 2. File specification lines contain one file specification surrounded by
  1646.    white space. The general syntax is:
  1647.          [drive:][path]filename.ext
  1648.  
  1649. Press F3 to save your changes or F4 to close the window (this will cause a
  1650. prompt to save).
  1651.  
  1652. NOTE: The ToolDriver editor can handle files up to 64K. This will handle
  1653. several thousand file names. If your application is larger than this, we
  1654. assume you have an editor! Shell to DOS from ToolDriver, edit the list with
  1655. that editor, and return to do the cross referencing.
  1656.  
  1657. Words to cross reference
  1658. This menu option allows you to identify additional words ( other than the
  1659. file names defined above) to be cross referenced. You can list words to be
  1660. included and words to be excluded. You can also specify where you want the
  1661. searching to be case sensitive and where it doesn't matter. (The default
  1662. for searching is case sensitive)
  1663.  
  1664. What do we mean by "word"? We mean that which is inbetween white space.
  1665. White space is here loosely defined to be those characters which are NOT
  1666. used to form symbols in a source language. You will see a complete example
  1667. below. You can also identify a set of words to be included where they share
  1668. a common prefix.
  1669.  
  1670. All of these are communicated to ToolDriver via a "word specification list"
  1671. file named FILEXREF.WSL. This file contains three types of lines:
  1672.  
  1673. 1. Comment lines have "--' in the first two columns. Comments may be
  1674.    placed anywhere in the file.
  1675.  
  1676.  
  1677.  
  1678.  
  1679.  
  1680.  
  1681.  
  1682.  
  1683.  
  1684.  
  1685.  
  1686.                                        30
  1687. 2. Option lines have "++" in the first two columns. Options are toggles.
  1688.    They may be placed anywhere. Four toggle options are supported:
  1689.  
  1690.    ■ CaseSensitive    Be sensitive to case when searching for the words
  1691.                       that follow. (this is the default)
  1692.  
  1693.    ■ CaseInsensitive  Ignore the case when searching for the words that
  1694.                       follow.
  1695.  
  1696.    ■ Include          Include the following words in the search list. (This is
  1697.                       the default)
  1698.  
  1699.    ■ Exclude          Exclude the following words from the search list so that
  1700.                       they do not appear on cross reference reports. Excluded
  1701.                       items will automatically marked as case sensitive. The
  1702.                       use of "*" is not supported for excluded words.
  1703.  
  1704. 3. Word specification lines have a single word surrounded by white space.
  1705.    Note that word phrases are not cross referenced, just individual words.
  1706.  
  1707. When you select the "Words to cross reference" option, ToolDriver will
  1708. provide a file edit window for you to define your word cross referencing
  1709. needs. The starter file provided with ToolDriver is shown below:
  1710.  
  1711. ────────────────────────────────────────────────────────────────────────────
  1712. -- This is the word specification list used by the cross rererence
  1713. -- utility.  For more information, see the end of this file.
  1714. ------------------------------------------------------------------
  1715. ++Include     The "++" option lines toggle options.
  1716. --   The next entry calls for cross referencing of all words starting
  1717. --   with "re".  Case sensitive compares for this type of entry is
  1718. --   automatic.  This "word prefix" format is not valid with the exclude --
  1719. ---   option.
  1720.   re*
  1721. ++CaseSensitive
  1722.   Visual
  1723.   window
  1724. ++CaseInsensitive
  1725.   COLUMN_NAME
  1726.   HELP
  1727. ++Exclude     The following entries exclude the C language keywords.
  1728. --            Change this list to those words you don't want cross
  1729. --            referenced.  Excluded names are automatically treated
  1730. --            as case sensitive.
  1731. --
  1732.    _Packed
  1733.    auto
  1734.    break
  1735.    case
  1736.    char
  1737.    const
  1738.    continue
  1739.    default
  1740.    do
  1741.  
  1742.  
  1743.  
  1744.  
  1745.                                        31
  1746.    double
  1747.    else
  1748.    enum
  1749.    extern
  1750.    float
  1751.    for
  1752.    goto
  1753.    if
  1754.    int
  1755.    long
  1756.    register
  1757.    return
  1758.    short
  1759.    signed
  1760.    sizeof
  1761.    static
  1762.    struct
  1763.    switch
  1764.    typedef
  1765.    union
  1766.    unsigned
  1767.    void
  1768.    volatile
  1769.    while
  1770. ────────────────────────────────────────────────────────────────────────────
  1771.  
  1772. The  control file above directs the cross reference process to include all
  1773. words starting with "re", and the specific words "Visual" and "window".
  1774. These three searches are to be case sensitive. It also calls for cross
  1775. referencing the words "COLUMN_NAME" and "HELP", regardless of case. Finally
  1776. it provides a list of words is to be excluded. This will cause the words
  1777. "register" and "return" to be excluded from the output.
  1778.  
  1779. Start cross referencing
  1780. Once you've set up the list of files to be examined and (optionally) the
  1781. words to search for, select this menu item to initiate cross referencing.
  1782.  
  1783. This is what the associated dialog looks like:
  1784.  
  1785. Figure  7: The Cross reference files dialog
  1786.  
  1787. ╔══[■}═════ Cross reference files ( and words) ══════════╗
  1788. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1789. ║ Type of output         ░ Optional output            ░░░║
  1790. ║░ (X) Extended reports  ░░ [X] Cross reference words ░░░║
  1791. ║░ ( ) Condensed reports ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1792. ║░ ( ) File Parts List   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1793. ║░ ( ) Export file       ░░░░»  OK  « ░░ Cancel░░░░░░░░░░║
  1794. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1795. ║░░░░░░░░░░░░░░░░ Supress entries with SBC > 50 ░░░░░░░░░║
  1796. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  1797. ╚════════════════════════════════════════════════════════╝
  1798.  
  1799.  
  1800.  
  1801.  
  1802.  
  1803.  
  1804.                                        32
  1805.  
  1806. Four types of output are available.
  1807.  
  1808. 1.   The extended report format displays the full file specification
  1809.         (drive, path, file name and extension). This choice produces these
  1810.         reports
  1811.  
  1812.         ■ Extended File Cross Reference Report,
  1813.         ■ Extended Word Usage Report, and
  1814.         ■ List of Unreferenced Files
  1815.  
  1816.      to be written to file FILEXREF.PRN.
  1817.  
  1818.  
  1819. 2.   Condensed format produces reports with file names only, without the
  1820.         path or file extension. The following reports
  1821.  
  1822.         ■ Condensed File Cross Reference Report,
  1823.         ■ Condensed Word Usage Report, and
  1824.         ■ List of Unreferenced Files
  1825.  
  1826.      will be written to file FILEXREF.PRN.
  1827.  
  1828. 3.   The third style mimics a fully exploded bill of material list. With
  1829.      this option you may use the SBC input box to control the number of
  1830.      setback levels to list (the default is 50). Pressing enter creates a
  1831.  
  1832.         ■ File Parts List Report
  1833.  
  1834.      will be written to file FILEXREF.PRN.
  1835.  
  1836. 4.   Export file format provides a means for you to take the cross
  1837.         reference information and use it with other software (e.g. a
  1838.         database program). This option produces
  1839.  
  1840.         ■ cross reference and unreferenced file information
  1841.  
  1842.      in file FILEXREF.XRF. The information is stored in quote and comma
  1843.      delimited export format which is supported by many software products.
  1844.  
  1845. To choose the optional word cross referencing, type "w" or press the space
  1846. bar when the cursor is on "Cross reference words". When you do this, the
  1847. word spaceification list  will be used (see "Words to cross reference" Page
  1848. 30). Otherwise it will be ignored for this cross referencing.
  1849.  
  1850. Use File│Print to print file FILEXREF.PRN, the report file. Note: The
  1851. reports require 132 print positions, so set your printer accordingly.
  1852.  
  1853. Extended Reports
  1854. The extended report style identifies each file with its full file
  1855. specification. This is the default. The first report of the extended series
  1856.  
  1857.  
  1858.  
  1859.  
  1860.  
  1861.  
  1862.  
  1863.                                        33
  1864. is show below. The center column lists all files in the file list in
  1865. alphabetical order by filename. The left- hand column lists files
  1866. containing one or more references to the center file's filename. The right-
  1867. hand column shows filename references found in the center column's file.
  1868.  
  1869. The first line shows usage and component information for HISTORY.DOC. The
  1870. filename "HISTORY" was found in the PACKLIST.DOC file, but HISTORY.DOC did
  1871. not contain references to any other of the selected files. (References to
  1872. its own name are ignored.) The second line shows usage and compoonent
  1873. information for PACKLIST.DOC. "PACKLIST" was not mentioned in any other
  1874. files. But PACKLIST.DOC referenced all the other file names.
  1875.  
  1876. This report can be used to see everywhere in your application that
  1877. filenames are specifically referenced. For Oracle users this gives
  1878. visability to the form (or forms) which invoke another form or a SQL
  1879. script. For those using make files it identifies the make file(s)
  1880. referencing each source program.
  1881.  
  1882. The files (page 30) and words (page 31) in the four ToolDriver DOC files
  1883. produce the following output:
  1884.  
  1885. Figure  8: The Extended File Cross Reference Report
  1886. ───────────────────────────────────────────────────────────────────────────
  1887. 05/23/93  07:58:22  FileXref  EXTENDED FILE CROSS REFERENCE REPORT   Page 1
  1888.  
  1889. FILE SPECIFICATION - REFERS TO:  FILE SPECIFICATION - REFERS TO:  FILENAMES
  1890. -------------------------------  -------------------------------  --------
  1891. C:\TOOLDRIV\PACKLIST.DOC         - C:\TOOLDRIV\HISTORY.DOC     -
  1892.                                  - C:\TOOLDRIV\PACKLIST.DOC    -  HISTORY
  1893.                                  -                             -  README
  1894.                                  -                             -  REGISTER
  1895. C:\TOOLDRIV\PACKLIST.DOC         - C:\TOOLDRIV\README.DOC      -
  1896. C:\TOOLDRIV\PACKLIST.DOC         - C:\TOOLDRIV\REGISTER.DOC    -
  1897.  
  1898. ***End of report***
  1899. ───────────────────────────────────────────────────────────────────────────
  1900.  
  1901.  
  1902.  
  1903.  
  1904.  
  1905.  
  1906.  
  1907.  
  1908.  
  1909.  
  1910.  
  1911.  
  1912.  
  1913.  
  1914.  
  1915.  
  1916.  
  1917.  
  1918.  
  1919.  
  1920.  
  1921.  
  1922.                                        34
  1923.  
  1924. The second in the series of extended reports is the optional word usage
  1925. report. The second line shows that the word "HELP" was found in the
  1926. HISTORY, PACKLIST, and README DOC files.
  1927.  
  1928. Note that the word Visual was not found in any file.
  1929.  
  1930. Figure  9: The Extended Word Usage Report
  1931. ───────────────────────────────────────────────────────────────────────────
  1932. 05/23/93  07:58:22  FileXref     EXTENDED WORD USAGE REPORT       Page 1
  1933.  
  1934. WORD                              IS REFERENCED BY FILENAME(S):
  1935. -------------------------------   -----------------------------
  1936. COLUMN_NAME                       C:\TOOLDRIV\HISTORY.DOC
  1937. HELP                              C:\TOOLDRIV\HISTORY.DOC
  1938.                                   C:\TOOLDRIV\PACKLIST.DOC
  1939.                                   C:\TOOLDRIV\README.DOC
  1940. Visual
  1941. re*                               C:\TOOLDRIV\HISTORY.DOC
  1942.                                   C:\TOOLDRIV\PACKLIST.DOC
  1943.                                   C:\TOOLDRIV\README.DOC
  1944.                                   C:\TOOLDRIV\REGISTER.DOC
  1945. reads                             C:\TOOLDRIV\HISTORY.DOC
  1946. receive                           C:\TOOLDRIV\REGISTER.DOC
  1947. record                            C:\TOOLDRIV\HISTORY.DOC
  1948. records                           C:\TOOLDRIV\HISTORY.DOC
  1949. reference                         C:\TOOLDRIV\README.DOC
  1950. referenced                        C:\TOOLDRIV\HISTORY.DOC
  1951.                                   C:\TOOLDRIV\PACKLIST.DOC
  1952. references                        C:\TOOLDRIV\HISTORY.DOC
  1953. referencing                       C:\TOOLDRIV\HISTORY.DOC
  1954.                                   C:\TOOLDRIV\PACKLIST.DOC
  1955. reflects                          C:\TOOLDRIV\HISTORY.DOC
  1956. registered                        C:\TOOLDRIV\PACKLIST.DOC
  1957.                                   C:\TOOLDRIV\README.DOC
  1958.                                   C:\TOOLDRIV\REGISTER.DOC
  1959. registration                      C:\TOOLDRIV\PACKLIST.DOC
  1960. relationships                     C:\TOOLDRIV\REGISTER.DOC
  1961. released                          C:\TOOLDRIV\HISTORY.DOC
  1962. renaming                          C:\TOOLDRIV\HISTORY.DOC
  1963. report                            C:\TOOLDRIV\HISTORY.DOC
  1964. reports                           C:\TOOLDRIV\HISTORY.DOC
  1965.                                   C:\TOOLDRIV\README.DOC
  1966. require                           C:\TOOLDRIV\HISTORY.DOC
  1967. required                          C:\TOOLDRIV\README.DOC
  1968.                                   C:\TOOLDRIV\REGISTER.DOC
  1969. requirements                      C:\TOOLDRIV\README.DOC
  1970.                                   C:\TOOLDRIV\REGISTER.DOC
  1971. residents                         C:\TOOLDRIV\REGISTER.DOC
  1972. returning                         C:\TOOLDRIV\HISTORY.DOC
  1973. rexx                              C:\TOOLDRIV\HISTORY.DOC
  1974. window                            C:\TOOLDRIV\README.DOC
  1975.  
  1976. ***End of report***
  1977. ───────────────────────────────────────────────────────────────────────────
  1978.  
  1979.  
  1980.  
  1981.                                        35
  1982.  
  1983. The last in the series of extended reports is the list of unreferenced
  1984. files. Although this information is also contained in the first report, if
  1985. there are many pages of output the information may be difficult to extract.
  1986. This report is very useful as it identifys the top level components of an
  1987. application, components not yet integrated, and old obsolete files.
  1988.  
  1989. In the example we're following, file PACKLIST.DOC is the only unreferenced
  1990. file since it is a packing list containing the names of all the files.
  1991.  
  1992. Figure 10: The Unreferenced Files Report
  1993. ───────────────────────────────────────────────────────────────────────────
  1994. 05/23/93  07:58:22  FileXref         LIST OF UNREFERENCED FILES     Page  1
  1995.  
  1996.      FILENAME  TYPE    PATH
  1997.      --------  ---     ------------------
  1998.      PACKLIST  DOC     C:\TOOLDRIV\
  1999.  
  2000. ***End of report***
  2001. ───────────────────────────────────────────────────────────────────────────
  2002.  
  2003. Condensed Reports
  2004. The condensed style of reports identify files by their filename alone,
  2005. without the drive, path, and file extension. The information content is
  2006. parallel to the extended series.
  2007.  
  2008. Below is the first of the series of condensed reports. Again file names are
  2009. listed in alphabetical order in the center column. To the left are the
  2010. files that reference the center column filename and to the right are those
  2011. that it references. Note that filename PACKLIST was not referenced by any
  2012. other file and that it references the HISTORY, README and REGISTER files.
  2013.  
  2014. Figure 11: The Condensed File Cross Reference Report
  2015. ───────────────────────────────────────────────────────────────────────────
  2016. 05/23/93  07:57:26  FileXref  CONDENSED FILE CROSS REFERENCE REPORT Page 1
  2017.  
  2018.   LIST OF REFERENCING FILES     FILENAME     LIST OF REFERENCED FILES
  2019. ----------------------------    ========    -----------------------------
  2020.                     PACKLIST  - HISTORY  -
  2021.                               - PACKLIST -  HISTORY   README    REGISTER
  2022.                     PACKLIST  - README   -
  2023.                     PACKLIST  - REGISTER -
  2024.  
  2025. ***End of report***
  2026. ───────────────────────────────────────────────────────────────────────────
  2027.  
  2028.  
  2029.  
  2030.  
  2031.  
  2032.  
  2033.  
  2034.  
  2035.  
  2036.  
  2037.  
  2038.  
  2039.  
  2040.                                        36
  2041.  
  2042. Figure 12: The Condensed Word Usage Report
  2043. ───────────────────────────────────────────────────────────────────────────
  2044. 05/23/93  07:57:26  FileXref      CONDENSED WORD USAGE REPORT       Page 1
  2045.  
  2046. WORD                             IS REFERENCED BY FILENAME(S):
  2047. -------------------------------  -----------------------------------------
  2048. COLUMN_NAME                      HISTORY
  2049. HELP                             HISTORY  PACKLIST README
  2050. Visual
  2051. re*                              HISTORY  PACKLIST README   REGISTER
  2052. reads                            HISTORY
  2053. receive                          REGISTER
  2054. record                           HISTORY
  2055. records                          HISTORY
  2056. reference                        README
  2057. referenced                       HISTORY  PACKLIST
  2058. references                       HISTORY
  2059. referencing                      HISTORY  PACKLIST
  2060. reflects                         HISTORY
  2061. registered                       PACKLIST README   REGISTER
  2062. registration                     PACKLIST
  2063. relationships                    REGISTER
  2064. released                         HISTORY
  2065. renaming                         HISTORY
  2066. report                           HISTORY
  2067. reports                          HISTORY  README
  2068. require                          HISTORY
  2069. required                         README   REGISTER
  2070. requirements                     README   REGISTER
  2071. residents                        REGISTER
  2072. returning                        HISTORY
  2073. rexx                             HISTORY
  2074. window                           README
  2075.  
  2076. ***End of report***
  2077. ───────────────────────────────────────────────────────────────────────────
  2078.  
  2079. The Unreferenced Files Report
  2080. ───────────────────────────────────────────────────────────────────────────
  2081. 05/23/93  07:57:26  FileXref      LIST OF UNREFERENCED FILES        Page  1
  2082.  
  2083.                    FILENAME  TYPE    PATH
  2084.                    --------  ---     --------------------
  2085.                    PACKLIST  DOC     C:\TOOLDRIV\
  2086.  
  2087. ***End of report***
  2088. ───────────────────────────────────────────────────────────────────────────
  2089.  
  2090. File Parts List
  2091.  
  2092. The file parts list report starts with each file which is an end item (is
  2093. not referenced by any other). The complete tree of referenced files is
  2094. represented by indenting, with setback codes for reference.  Circular
  2095. references (loops) are identified when found. When an item has been
  2096. exploded earlier you will see the notation "Ref: 1234", where 1234 is the
  2097. line where it was first exploded. Following is a sample:
  2098.  
  2099.                                        37
  2100. Figure 13: The File Parts List Report
  2101.  ───────────────────────────────────────────────────────────────────────────
  2102.  06/09/93  11:18:03  FileXref         Indented File Parts List     Page   1
  2103.  
  2104.  
  2105.  Ref# SBC Filename Type Path
  2106.       --- -------- ---- --------------------
  2107.     1   0 COLORSEL CPP  D:\BORLANDC\TVISION\SOURCE\
  2108.     2     1 COLORSEL H    D:\BORLANDC\TVISION\INCLUDE\
  2109.     3     1 GRP      CPP  D:\BORLANDC\TVISION\SOURCE\
  2110.     4       2 TGROUP   CPP  D:\BORLANDC\TVISION\SOURCE\
  2111.     5         3 GRP      CPP  D:\BORLANDC\TVISION\SOURCE\  Circular: 3
  2112.     6         3 NEW      CPP  D:\BORLANDC\TVISION\SOURCE\
  2113.     7           4 TV       H    D:\BORLANDC\TVISION\INCLUDE\
  2114.     8             5 APP      H    D:\BORLANDC\TVISION\INCLUDE\
  2115.     9             5 BUFFERS  H    D:\BORLANDC\TVISION\INCLUDE\
  2116.    10             5 CONFIG   H    D:\BORLANDC\TVISION\INCLUDE\
  2117.    11             5 DIALOGS  H    D:\BORLANDC\TVISION\INCLUDE\
  2118.    12             5 DRAWBUF  H    D:\BORLANDC\TVISION\INCLUDE\
  2119.    13             5 EDITORS  H    D:\BORLANDC\TVISION\INCLUDE\
  2120.    14             5 MENUS    H    D:\BORLANDC\TVISION\INCLUDE\
  2121.    15             5 OBJECTS  H    D:\BORLANDC\TVISION\INCLUDE\
  2122.    16             5 RESOURCE H    D:\BORLANDC\TVISION\INCLUDE\
  2123.    17             5 SYSTEM   H    D:\BORLANDC\TVISION\INCLUDE\
  2124.    18             5 TKEYS    H    D:\BORLANDC\TVISION\INCLUDE\
  2125.    19             5 TTYPES   H    D:\BORLANDC\TVISION\INCLUDE\
  2126.    20             5 TVOBJS   H    D:\BORLANDC\TVISION\INCLUDE\
  2127.    21             5 UTIL     H    D:\BORLANDC\TVISION\INCLUDE\
  2128.    22             5 VIEWS    H    D:\BORLANDC\TVISION\INCLUDE\
  2129.    23         3 TEVENT   CPP  D:\BORLANDC\TVISION\SOURCE\
  2130.    24           4 TMOUSE   CPP  D:\BORLANDC\TVISION\SOURCE\
  2131.    25             5 TV       H    D:\BORLANDC\TVISION\INCLUDE\  Ref: 7
  2132.    26           4 TSCREEN  CPP  D:\BORLANDC\TVISION\SOURCE\
  2133.    27             5 TV       H    D:\BORLANDC\TVISION\INCLUDE\  Ref: 7
  2134.    28           4 TV       H    D:\BORLANDC\TVISION\INCLUDE\  Ref: 7
  2135.    29         3 TPOINT   CPP  D:\BORLANDC\TVISION\SOURCE\
  2136.    30           4 TV       H    D:\BORLANDC\TVISION\INCLUDE\  Ref: 7
  2137.    31         3 TV       H    D:\BORLANDC\TVISION\INCLUDE\  Ref: 7
  2138.    32         3 TVIEW    CPP  D:\BORLANDC\TVISION\SOURCE\
  2139.    33           4 MAPCOLOR CPP  D:\BORLANDC\TVISION\SOURCE\
  2140.    34             5 TV       H    D:\BORLANDC\TVISION\INCLUDE\  Ref: 7
  2141.    35             5 TVIEW    CPP  D:\BORLANDC\TVISION\SOURCE\  Circular: 32
  2142.  ───────────────────────────────────────────────────────────────────────────
  2143.  
  2144. Export files
  2145. The quote and comma delimited export files (see Figure 14) are provided so
  2146. you can import cross reference information into your software for custom
  2147. processing and reporting.
  2148.  
  2149.  
  2150.  
  2151.  
  2152.  
  2153.  
  2154.  
  2155.  
  2156.  
  2157.  
  2158.                                       37A
  2159. Figure 14: The Export File
  2160. ───────────────────────────────────────────────────────────────────────────
  2161. "COLUMN_NAME","C:\TOOLDRIV\HISTORY.DOC","0100110"
  2162. "HELP","C:\TOOLDRIV\HISTORY.DOC","0100110"
  2163. "HELP","C:\TOOLDRIV\PACKLIST.DOC","0100110"
  2164. "HELP","C:\TOOLDRIV\README.DOC","0100110"
  2165. "HISTORY","C:\TOOLDRIV\PACKLIST.DOC","1000110"
  2166. "PACKLIST","","1000010"
  2167. "README","C:\TOOLDRIV\PACKLIST.DOC","1000110"
  2168. "REGISTER","C:\TOOLDRIV\PACKLIST.DOC","1000110"
  2169. "Visual","","0100011"
  2170. "re","C:\TOOLDRIV\HISTORY.DOC","0011111"
  2171. "re","C:\TOOLDRIV\PACKLIST.DOC","0011111"
  2172. "re","C:\TOOLDRIV\README.DOC","0011111"
  2173. "re","C:\TOOLDRIV\REGISTER.DOC","0011111"
  2174. "reads","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2175. "receive","C:\TOOLDRIV\REGISTER.DOC","0001111"
  2176. "record","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2177. "records","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2178. "reference","C:\TOOLDRIV\README.DOC","0001111"
  2179. "referenced","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2180. "referenced","C:\TOOLDRIV\PACKLIST.DOC","0001111"
  2181. "references","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2182. "referencing","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2183. "referencing","C:\TOOLDRIV\PACKLIST.DOC","0001111"
  2184. "reflects","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2185. "registered","C:\TOOLDRIV\PACKLIST.DOC","0001111"
  2186. "registered","C:\TOOLDRIV\README.DOC","0001111"
  2187. "registered","C:\TOOLDRIV\REGISTER.DOC","0001111"
  2188. "registration","C:\TOOLDRIV\PACKLIST.DOC","0001111"
  2189. "relationships","C:\TOOLDRIV\REGISTER.DOC","0001111"
  2190. "released","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2191. "renaming","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2192. "report","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2193. "reports","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2194. "reports","C:\TOOLDRIV\README.DOC","0001111"
  2195. "require","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2196. "required","C:\TOOLDRIV\README.DOC","0001111"
  2197. "required","C:\TOOLDRIV\REGISTER.DOC","0001111"
  2198. "requirements","C:\TOOLDRIV\README.DOC","0001111"
  2199. "requirements","C:\TOOLDRIV\REGISTER.DOC","0001111"
  2200. "residents","C:\TOOLDRIV\REGISTER.DOC","0001111"
  2201. "returning","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2202. "rexx","C:\TOOLDRIV\HISTORY.DOC","0001111"
  2203. "window","C:\TOOLDRIV\README.DOC","0100111"
  2204. ───────────────────────────────────────────────────────────────────────────
  2205.  
  2206. File FILEXREF.XRF is used for the cross reference export data. Each line
  2207. has three columns:
  2208.  
  2209. 1.   A symbol
  2210.  
  2211. 2.   The referencing file's specification ( or null if no files reference
  2212.      the symbol).
  2213.  
  2214. 3.   A seven character flag column. Each position is either 0 (false) or 1
  2215.      (true). The meanings of each column are shown in Table 7:
  2216.  
  2217.                                        38
  2218.  
  2219.  
  2220. Table 7: Export file flags
  2221. ───────────────────────────────────────────────
  2222. 1234567
  2223. -------
  2224.        The symbol in the first column is:
  2225. 1......    a filename.
  2226. .1.....    a whole word.
  2227. ..1....    a word prefix.
  2228. ...1...    an expansion of a word prefix.
  2229. ....1.. The symbol was referenced.
  2230. .....1. The symbol was marked for inclusion.
  2231. ......1 The search needs to be case sensitive.
  2232. ───────────────────────────────────────────────
  2233.  
  2234.  
  2235. View the output log
  2236. This command gives you a file viewer window to browse the messages about
  2237. the cross referencing. These document the scope of the run (files and words
  2238. specified, options, and record counts). You can use File│Print to get a
  2239. hardcopy of this output. It is stored in FILEXREF.MSG. The output for the
  2240. sample we're following is:
  2241.  
  2242. ───────────────────────────────────────────────────────────────────────────
  2243. FileXref - Cross Reference Utility  Version 2.02
  2244. Copyright 1990-1993 ConVal Software, Inc.  All rights reserved.
  2245.  
  2246. 05/23/93  08:00:43
  2247.  
  2248. Message File opened as FILEXREF.MSG.
  2249. File Specification List opened as FILEXREF.FSL.
  2250. Word Specification List opened as FILEXREF.WSL
  2251. Cross reference file opened as FILEXREF.XRF.
  2252. Report file opened as FILEXREF.PRN.
  2253.  
  2254. Processing Option is /PRNE.
  2255.  
  2256. (The default for items below is Include and CaseSensitive)
  2257. Items in the word specification list:
  2258.     COLUMN_NAME CaseInsensitive
  2259.     HELP CaseInsensitive
  2260.     Visual
  2261.     _Packed Exclude
  2262.     auto Exclude
  2263.     break Exclude
  2264.     case Exclude
  2265.     char Exclude
  2266.     const Exclude
  2267.     continue
  2268.     default
  2269.     do
  2270.     double
  2271.  
  2272.  
  2273.  
  2274.  
  2275.  
  2276.                                        39
  2277.     else
  2278.     enum
  2279.     extern Exclude
  2280.     float Exclude
  2281.     for Exclude
  2282.     goto Exclude
  2283.     if Exclude
  2284.     int Exclude
  2285.     long Exclude
  2286.     re*
  2287.     register Exclude
  2288.     return Exclude
  2289.     short Exclude
  2290.     signed Exclude
  2291.     sizeof Exclude
  2292.     static Exclude
  2293.     struct Exclude
  2294.     switch Exclude
  2295.     typedef Exclude
  2296.     union Exclude
  2297.     unsigned Exclude
  2298.     void Exclude
  2299.     volatile Exclude
  2300.     while Exclude
  2301.     window
  2302.  
  2303. Examining D:\TOOLDRIV\HISTORY.DOC
  2304. Examining D:\TOOLDRIV\PACKLIST.DOC
  2305. Examining D:\TOOLDRIV\README.DOC
  2306. Examining D:\TOOLDRIV\REGISTER.DOC
  2307.  
  2308. RECORD COUNTS
  2309.  
  2310. File Specification List records READ:             25
  2311. Word Specification List records READ:             74
  2312. Characters READ from the input files:         14,626
  2313. Cross Reference Records written:                   0
  2314. Report Records written:                           67
  2315. Message records written:                          69
  2316.  
  2317. 05/23/93  08:00:47
  2318. ───────────────────────────────────────────────────────────────────────────
  2319.  
  2320. NameChanger menu Alt+N
  2321. Use the NameChanger menu whenever you want to go back and make your naming
  2322. conventions consistent across your application(s). You might decide to do
  2323. this after each revision level is complete to keep order. And, now that you
  2324. have such a tool, you may want to go back to some older code you're still
  2325. maintaining and clean it up too.
  2326.  
  2327.  
  2328.  
  2329.  
  2330.  
  2331.  
  2332.  
  2333.  
  2334.  
  2335.                                        40
  2336. You will also want to use the NameChanger menu when you have successful
  2337. code on one platform and want to port it to another. Download non-DOS code
  2338. to your PC, do the renaming, and recompile on DOS. Or, do renaming, upload
  2339. to a non-DOS platform and recompile there.
  2340.  
  2341. This command invokes a DOS program - NAMEC.EXE. This may be executed
  2342. outside of the ToolDriver environment.
  2343.  
  2344. Files to process
  2345. This is where you identify the files to be processed by NameChanger. The
  2346. dialog box follows:
  2347.  
  2348. Figure 15: NameChanger Files dialog
  2349.  
  2350. ╔══[■}══  Files with names to be changed ════════╗
  2351. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2352. ║░[X]  Generate a file list for me ░░░░░░░░░░░░░░║
  2353. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2354. ║░     using the directory:  ░░░░░░░░░░░░░░░░░░░░║
  2355. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2356. ║░»C:\PROJECT1                             ░░░░░║
  2357. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2358. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2359. ║░░░░░░░░░░░░░░░░░░░»  OK  «░░  Cancel  ░░░░░░░░░║
  2360. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2361. ╚════════════════════════════════════════════════╝
  2362.  
  2363. If you check the check box and enter a directory (as above) or drive (like
  2364. C:), then a list will be prepared for you. It will be written to file
  2365. NAMEC.FSL (File Specification List). The list will include only those files
  2366. in the directory entered.
  2367.  
  2368. In any case you will be presented with an edit window for this file. So the
  2369. content of the file edit window will be what was just generated if you
  2370. checked the check box, or it will be as delivered on the installation disk,
  2371. or as most recently edited by you.
  2372.  
  2373. We will trace a specific NameChanger request using the following
  2374. files (from the ToolDriver distibution disk):
  2375. ───────────────────────────────────────────────────────
  2376. -- This data defines the list of files to be processed.
  2377. D:\TOOLDRIV\README.DOC
  2378. D:\TOOLDRIV\HISTORY.DOC
  2379. D:\TOOLDRIV\PACKLIST.DOC
  2380. D:\TOOLDRIV\REGISTER.DOC
  2381. ───────────────────────────────────────────────────────
  2382.  
  2383. There are two types of lines in the NameChanger file specification list:
  2384.  
  2385. 1. A comment line contains "--" in the first two columns.
  2386.  
  2387. 2.   A file specification line contains one file spec surrounded by white
  2388.      space. The general syntax is:
  2389.  
  2390.     [drive:][path]filename.ext
  2391.  
  2392.  
  2393.  
  2394.                                        41
  2395.  
  2396. Press F3 to save your changes or F4 to close the window (this will cause a
  2397. prompt to save).
  2398.  
  2399. NOTE: The editor can handle files up to 64K. This will handle several
  2400. thousand file names. If your application is larger than this we assume you
  2401. have an editor! Drop out of ToolDriver, edit the list with that editor, and
  2402. return to ToolDriver to change names.
  2403.  
  2404. Names to be changed
  2405. When you want to define the names to be changed, choose this menu option. A
  2406. file editor window will be displayed so you can add one line for each name
  2407. change.
  2408.  
  2409. ─────────────────────────────────────────────────────────────────
  2410. -- This is a symbol rename list used by ToolDriver's NameChanger
  2411. -- utility.
  2412. ++CaseInsensitive
  2413. EMP_NM    Employee_Name
  2414. ++CaseSensitive
  2415. QOH  QuantityOnHand
  2416. ─────────────────────────────────────────────────────────────────
  2417.  
  2418. This file contains three types of lines:
  2419.  
  2420. 1. A comment line has "--' in the first two columns.
  2421.  
  2422. 2.   An option line has "++' in the first two columns followed immediately
  2423.      by one of these options:
  2424.  
  2425.    ■ CaseSensitive - start case sensitivity
  2426.  
  2427.    ■ CaseInsensitive - start ignoring case
  2428.  
  2429. 3.   A symbol remapping line has two symbols surrounded by white space. The
  2430.      first symbol will be replaced by the second one. Note that NameChanger
  2431.      just transforms individual symbols, not partial symbols or multiple
  2432.      symbols.
  2433.  
  2434. The controls above tell NameChanger to transform the complete symbol
  2435. "EMP_NM" to "EMPLOYEE_NM" everywhere it's found, independently of the case
  2436. used.
  2437.  
  2438. The chart below shows the effect:
  2439.  
  2440. ──────────────────────────────────────
  2441.   Old Symbol     New Symbol
  2442.     emp_nm         EMPLOYEE_NAME
  2443.     Emp_nm         EMPLOYEE_NAME
  2444.     EMP_NM         EMPLOYEE_NAME
  2445.     EMP_NM2        --- no change ---
  2446.     P_emp_nm_2     --- no change ---
  2447. ──────────────────────────────────────
  2448.  
  2449.  
  2450.  
  2451.  
  2452.  
  2453.                                        42
  2454. It also specifies that the complete symbol "QOH" is to be changed to
  2455. "QuantityOnHand", but only where the case matches exactly.
  2456.  
  2457. The following shows what this does:
  2458.  
  2459. ──────────────────────────────────────
  2460.   Old Symbol     New Symbol
  2461.     qoh            --- no change ---
  2462.     QOH            QuantityOnHand
  2463.     aqohb          --- no change ---
  2464. ──────────────────────────────────────
  2465.  
  2466. Start name changing
  2467. After you've defined the files and names to be changed, select the "Start
  2468. name changing" dialog. It looks like this:
  2469.  
  2470. Figure 16: The Change names dialog
  2471.  
  2472. ╔══[■}═══════════════ Change names ══════════════════════╗
  2473. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2474. ║ NOTE: Output files will be written to this  ░░░░░░░░░░░║
  2475. ║░      directory:                            ░░░░░░░░░░░║
  2476. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2477. ║░ C:\TOOLDRIV\WORK ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2478. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2479. ║░░░[ ] Delete prior output░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2480. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2481. ║░░░░░░░░░░░░░░░░░░ »  OK  « ░░ Cancel ░░░░░░░░░░░░░░░░░░║
  2482. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2483. ╚════════════════════════════════════════════════════════╝
  2484.  
  2485. Whenever you do name changing, the output files will be written to a
  2486. ToolDriver's subdirectory named WORK. This is the WORK directory's only
  2487. purpose. Your files will never be rewritten in place! If you are rerunning
  2488. a name changing task, no work will be performed if any output file already
  2489. exists on the ToolDriver WORK subdirectory. To delete ALL files in the
  2490. working directory, check the checkbox. As a final precaution, you will be
  2491. asked to confirm the deletion, when the process starts. This is a reminder
  2492. to move our prior output to a permanent home in another directory before
  2493. renaming other projects. When the changing of names is complete, you will
  2494. be presented with a file viewer window to browse a log of the renaming
  2495. activity. This file is NAMEC.MSG.
  2496.  
  2497.  
  2498.  
  2499.  
  2500.  
  2501.  
  2502.  
  2503.  
  2504.  
  2505.  
  2506.  
  2507.  
  2508.  
  2509.  
  2510.  
  2511.  
  2512.                                        43
  2513. Its output for the file list and symbol rename list above are:
  2514.  
  2515. ────────────────────────────────────────────────────────────────────────────
  2516. NameChanger - Symbol Renaming Utility Version 2.02
  2517. Copyright 1991-1993 ConVal Software, Inc.    All rights reserved.
  2518. 05/28/93  20:07:36
  2519.  
  2520. Invoked with OUTDIR=D:\TOOLDRIV\WORK
  2521.  
  2522. Message File opened as NAMEC.MSG.
  2523. File Specification List opened as NAMEC.FSL.
  2524. Symbol Rename List opened as NAMEC.SRL.
  2525.  
  2526. (The default for items is CaseSensitive)
  2527. Items in the Symbol Rename List:
  2528.     EMP_NM  Employee_Name  CaseInsensitive
  2529.     QOH  QuantityOnHand
  2530.  
  2531. Processing D:\TOOLDRIV\HISTORY.DOC
  2532. Processing D:\TOOLDRIV\PACKLIST.DOC
  2533. Processing D:\TOOLDRIV\README.DOC
  2534. Processing D:\TOOLDRIV\REGISTER.DOC
  2535.  
  2536. Symbol QOH was not found in any input file.
  2537.  
  2538. File D:\TOOLDRIV\HISTORY.DOC : The output file was modified as requested.
  2539. File D:\TOOLDRIV\PACKLIST.DOC : This file contained no symbols for
  2540. renaming. The output file for it is identical.
  2541. File D:\TOOLDRIV\README.DOC : This file contained no symbols for renaming.
  2542.       The output file for it is identical.
  2543. File D:\TOOLDRIV\REGISTER.DOC : This file contained no symbols for
  2544. renaming.  The output file for it is identical.
  2545.  
  2546. RECORD COUNTS
  2547. File Specification List records READ:             25
  2548. Symbol Rename List records READ:                  43
  2549. Characters READ from the input files:         14,772
  2550. Characters WRITTEN to output files:           14,779
  2551. Message records WRITTEN:                          41
  2552.  
  2553. 05/28/93  20:07:42
  2554. ────────────────────────────────────────────────────────────────────────────
  2555.  
  2556. Note that only the HISTORY.DOC file had changes made. Also note that the
  2557. symbol QOH was not found in any file.
  2558.  
  2559. View the output files
  2560. Select this option to inspect the results of your name changing. The
  2561. following dialog lets you select a file on the ToolDriver working directory
  2562. (where NameChanger places its output).
  2563.  
  2564.  
  2565.  
  2566.  
  2567.  
  2568.  
  2569.  
  2570.  
  2571.                                        44
  2572. Figure 17: View the name-changed files dialog box
  2573.  
  2574. ╔══[■}═════════════════ View a File ═══════════════════╗
  2575. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2576. ║░░ Name░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2577. ║░░░ *.*                              ░░░░░ Open  ░░║
  2578. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2579. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2580. ║░░ Files                               ░░░░░░░░░░░░░░░║
  2581. ║░░░ FILEXREF.PRN      │  TST01.C       ░░░░  Cancel ░░║
  2582. ║░░░ FILEXREF.DOC      │  TST02.CPP     ░░░░░░░░░░░░░░░║
  2583. ║░░░ HISTORY.DOC       │  TST03.H       ░░░░░░░░░░░░░░░║
  2584. ║░░░ NAMECHNG.DOC      │  TST04.PAS     ░░░░░░░░░░░░░░░║
  2585. ║░░░ PACKLIST.DOC      │  ..\           ░░░░░░░░░░░░░░░║
  2586. ║░░░ REGISTER.DOC      │                ░░░░░░░░░░░░░░░║
  2587. ║░░░ TOOLDRIV.DOC      │                ░░░░░░░░░░░░░░░║
  2588. ║░░░ ■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓     ░░░░░░░░░░░░░░░║
  2589. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2590. ║░░░C:\TOOLDRIV\WORK\*.*                               ║
  2591. ║░░░FILEXREF.PRN 88722           May 18,1993   08:25a  ║
  2592. ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
  2593. ╚══════════════════════════════════════════════════════╝
  2594.  
  2595.  
  2596. See the "View a file" dialog description on page 21 for a review of using
  2597. this dialog.
  2598.  
  2599. Window menu Alt+W
  2600. The Window menu contains window-management commands. Most of the windows
  2601. you open from this menu have all the standard window elements like scroll
  2602. bars, a close box, and zoom boxes. Refer to page 15 for information on
  2603. these elements and how to use them.
  2604.  
  2605. Size/Move  Ctrl+F5
  2606. Choose Window│Size/Move to change the size or position of the active
  2607. window.
  2608.  
  2609. When you choose this command, the active window moves in response to the
  2610. arrow keys. When the window is where you want, press Enter. You can also
  2611. move a window by dragging its title bar.
  2612.  
  2613. If you press shift while you use the arrow keys, you can change the size of
  2614. the window. When it's the size you want, press enter. If a window has a
  2615. resize corner, you can drag that corner or any other corner to resize it.
  2616.  
  2617. Zoom F5
  2618. Choose Window│Zoom to resize the active window to the maximum size. If the
  2619. window is already zoomed, you can choose this command again to restore it
  2620. to its previous size. You can also double-click anywhere on the top line
  2621. (except where an icon appears) of a window to zoom or unzoom it.
  2622.  
  2623. Tile
  2624. Choose Window│Tile to arrange all your open windows like tiles on the
  2625. screen.
  2626.  
  2627.  
  2628.  
  2629.  
  2630.                                        45
  2631. Cascade
  2632. Choose Window│Cascade to stack all open windows so the top of each (with
  2633. its window number) shows.
  2634.  
  2635. Next F6
  2636. Choose Window│Next to make the next window active and visible.
  2637.  
  2638. Previous   Shift+F6
  2639. Choose Window│Previous to make the prior window active and visible.
  2640.  
  2641. Close   F4
  2642. To close the current window, press F4.
  2643.  
  2644. Help menu  Alt+H
  2645. The help menu gives you access to online help in a special window. There is
  2646. help information on virtually all aspects of the ToolDriver environment. To
  2647. open a Help window, do one of these actions:
  2648. ■ Press F1 at any time (including from any dialog box or when any menu
  2649. command is    selected).
  2650.  
  2651. ■ Click Help on the status line.
  2652.  
  2653. To close the Help window, press Esc, click the close box, or choose
  2654. Window│Close. You can keep the Help window onscreen while you work in
  2655. another window unless you pressed F1.
  2656.  
  2657. Help screens often contain keywords (highlighted text) that you can choose
  2658. to get more information. Press Tab to move to any keyword; press Enter to
  2659. get more detailed help. (As an alternative, move the cursor to the
  2660. highlighted keyword and press Enter.) With a mouse, you can double-click
  2661. any keyword to open the Help text for that item.
  2662.  
  2663. When you're in a detailed help screen (you got there from another help
  2664. screen by selecting a keyword) and you want to go back to the previous
  2665. help, press Alt+F1. By doing this repeatedly you can back-track to the
  2666. original help screen where you selected the first keyword.
  2667.  
  2668. Contents
  2669. The Help│Contents command opens the Help window with the main table of
  2670. contents displayed. From this window, you can branch to any other part of
  2671. the help system.
  2672.  
  2673. You can get help on Help by pressing F1 when the Help window is active. You
  2674. can also reach this screen by clicking Help on the status line.
  2675.  
  2676. Index
  2677. The Help│Index command displays a full list of Help keywords (the special
  2678. highlighted text in Help screens that let you quickly move to a related
  2679. screen). These are arranged in alphabetical order.
  2680.  
  2681. Tab to the item you want and press Enter, or Tab to the "next page" keyword
  2682. and press Enter to see the next page of keywords.
  2683.  
  2684. Use Alt+F1 to get back to the previous help screen.
  2685.  
  2686.  
  2687.  
  2688.  
  2689.                                        46
  2690. INDEX
  2691. ────────────────────────────────────────────────────────────────────────────
  2692.  
  2693. Edit menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
  2694. File
  2695.     export data, choosing . . . . . . . . . . . . . . . . . . . . . . . . 32
  2696.     export data, sample . . . . . . . . . . . . . . . . . . . . . . . . . 38
  2697.     extension list, editing . . . . . . . . . . . . . . . . . . . . . . . 25
  2698.     list of files to cross reference, editing . . . . . . . . . . . . . . 29
  2699.     list of files to name change, editing . . . . . . . . . . . . . . . . 41
  2700.     list of names to change, editing. . . . . . . . . . . . . . . . . . . 42
  2701.     list of words to cross reference, editing . . . . . . . . . . . . . . 30
  2702.     menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
  2703. ToolDriver packing list . . . . . . . . . . . . . . . . . . . . . . . . . 39
  2704. FileXref menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
  2705. Help.menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
  2706. Hot keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
  2707. Log
  2708.     of.cross referencing activity . . . . . . . . . . . . . . . . . . . . 39
  2709.     of.name changing activity . . . . . . . . . . . . . . . . . . . . . . 44
  2710. NameChanger menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
  2711. Report
  2712.     printing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
  2713.     sample, Condensed File Cross Reference. . . . . . . . . . . . . . . . 36
  2714.     sample, Condensed Word Usage. . . . . . . . . . . . . . . . . . . . . 37
  2715.     sample, Extended File Cross Reference . . . . . . . . . . . . . . . . 34
  2716.     sample, Extended Word Usage . . . . . . . . . . . . . . . . . . . . . 35
  2717.     sample, File Parts List . . . . . . . . . . . . . . . . . . . . . . . 37A
  2718.     sample, Unreferenced Files. . . . . . . . . . . . . . . . . . . . 36, 37
  2719.     selecting the type of . . . . . . . . . . . . . . . . . . . . . . . . 32
  2720. Search menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
  2721. Window menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
  2722.  
  2723.  
  2724.  
  2725.  
  2726.  
  2727.  
  2728. ────────────────────────
  2729. End of User Guide for ToolDriver
  2730. ────────────────────────
  2731.  
  2732.  
  2733.  
  2734.  
  2735.  
  2736.  
  2737.  
  2738.  
  2739.  
  2740.  
  2741.  
  2742.  
  2743.  
  2744.  
  2745.  
  2746.  
  2747.  
  2748.                                        47
  2749.